trait ConfigReader[A] extends AnyRef
Trait for objects capable of reading objects of a given type from ConfigValues
.
- A
the type of objects readable by this
ConfigReader
- Alphabetic
- By Inheritance
- ConfigReader
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
from(cur: ConfigCursor): Result[A]
Convert the configuration given by a cursor into an instance of
A
if possible.Convert the configuration given by a cursor into an instance of
A
if possible.- cur
The cursor from which the config should be loaded
- returns
either a list of failures or an object of type
A
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
contramapConfig(f: (ConfigValue) ⇒ ConfigValue): ConfigReader[A]
Applies a function to configs before passing them to this reader.
Applies a function to configs before passing them to this reader.
- f
the function to apply to input configs
- returns
a
ConfigReader
returning the results of this reader when the input configs are mapped usingf
.
-
def
contramapCursor(f: (ConfigCursor) ⇒ ConfigCursor): ConfigReader[A]
Applies a function to config cursors before passing them to this reader.
Applies a function to config cursors before passing them to this reader.
- f
the function to apply to input config cursors
- returns
a
ConfigReader
returning the results of this reader when the input cursors are mapped usingf
.
-
def
emap[B](f: (A) ⇒ Either[FailureReason, B]): ConfigReader[B]
Maps a function that can possibly fail over the results of this reader.
Maps a function that can possibly fail over the results of this reader.
- B
the value read by the function in case of success
- f
the function to map over this reader
- returns
a
ConfigReader
returning the results of this reader mapped byf
, with the resultingEither
flattened as a success or failure.
-
def
ensure(pred: (A) ⇒ Boolean, message: (A) ⇒ String): ConfigReader[A]
Fails the reader if the condition does not hold for the result.
Fails the reader if the condition does not hold for the result.
- pred
the condition to assert
- message
the failed validation message
- returns
a
ConfigReader
returning the results of this reader if the condition holds or a failed reader otherwise.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
flatMap[B](f: (A) ⇒ ConfigReader[B]): ConfigReader[B]
Monadically bind a function over the results of this reader.
Monadically bind a function over the results of this reader.
- B
the type of the objects readable by the resulting
ConfigReader
- f
the function to bind over this reader
- returns
a
ConfigReader
returning the results of this reader bound byf
.
-
def
from(config: ConfigValue): Result[A]
Convert the given configuration into an instance of
A
if possible.Convert the given configuration into an instance of
A
if possible.- config
The configuration from which the config should be loaded
- returns
either a list of failures or an object of type
A
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
map[B](f: (A) ⇒ B): ConfigReader[B]
Maps a function over the results of this reader.
Maps a function over the results of this reader.
- B
the output type of the function
- f
the function to map over this reader
- returns
a
ConfigReader
returning the results of this reader mapped byf
.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
orElse[AA >: A, B <: AA](reader: ⇒ ConfigReader[B]): ConfigReader[AA]
Combines this reader with another, returning the result of the first one that succeeds.
Combines this reader with another, returning the result of the first one that succeeds.
- AA
the type of the objects readable by both readers
- reader
the reader to combine with this one
- returns
a
ConfigReader
returning the results of this reader if it succeeds and the results ofreader
otherwise.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
zip[B](reader: ConfigReader[B]): ConfigReader[(A, B)]
Combines this reader with another, returning both results as a pair.
Combines this reader with another, returning both results as a pair.
- B
the type of the objects readable by the provided reader
- reader
the reader to combine with this one
- returns
a
ConfigReader
returning the results of both readers as a pair.