Trait for objects capable of reading objects of a given type from ConfigValues.
Type parameters
- A
-
the type of objects readable by this
ConfigReader
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Members list
Value members
Abstract methods
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.
Value parameters
- cur
-
The cursor from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
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.
Value parameters
- cur
-
The cursor from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
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.
Value parameters
- cur
-
The cursor from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
A
Concrete methods
Applies a function to configs before passing them to this reader.
Applies a function to configs before passing them to this reader.
Value parameters
- f
-
the function to apply to input configs
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input configs are mapped usingf.
Applies a function to configs before passing them to this reader.
Applies a function to configs before passing them to this reader.
Value parameters
- f
-
the function to apply to input configs
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input configs are mapped usingf.
Applies a function to configs before passing them to this reader.
Applies a function to configs before passing them to this reader.
Value parameters
- f
-
the function to apply to input configs
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input configs are mapped usingf.
Applies a function to config cursors before passing them to this reader.
Applies a function to config cursors before passing them to this reader.
Value parameters
- f
-
the function to apply to input config cursors
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input cursors are mapped usingf.
Applies a function to config cursors before passing them to this reader.
Applies a function to config cursors before passing them to this reader.
Value parameters
- f
-
the function to apply to input config cursors
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input cursors are mapped usingf.
Applies a function to config cursors before passing them to this reader.
Applies a function to config cursors before passing them to this reader.
Value parameters
- f
-
the function to apply to input config cursors
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader when the input cursors are mapped usingf.
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.
Type parameters
- B
-
the value read by the function in case of success
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf, with the resultingEitherflattened as a success or failure.
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.
Type parameters
- B
-
the value read by the function in case of success
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf, with the resultingEitherflattened as a success or failure.
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.
Type parameters
- B
-
the value read by the function in case of success
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf, with the resultingEitherflattened as a success or failure.
Fails the reader if the condition does not hold for the result.
Fails the reader if the condition does not hold for the result.
Value parameters
- message
-
the failed validation message
- pred
-
the condition to assert
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if the condition holds or a failed reader otherwise.
Fails the reader if the condition does not hold for the result.
Fails the reader if the condition does not hold for the result.
Value parameters
- message
-
the failed validation message
- pred
-
the condition to assert
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if the condition holds or a failed reader otherwise.
Fails the reader if the condition does not hold for the result.
Fails the reader if the condition does not hold for the result.
Value parameters
- message
-
the failed validation message
- pred
-
the condition to assert
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if the condition holds or a failed reader otherwise.
Monadically bind a function over the results of this reader.
Monadically bind a function over the results of this reader.
Type parameters
- B
-
the type of the objects readable by the resulting
ConfigReader
Value parameters
- f
-
the function to bind over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader bound byf.
Monadically bind a function over the results of this reader.
Monadically bind a function over the results of this reader.
Type parameters
- B
-
the type of the objects readable by the resulting
ConfigReader
Value parameters
- f
-
the function to bind over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader bound byf.
Monadically bind a function over the results of this reader.
Monadically bind a function over the results of this reader.
Type parameters
- B
-
the type of the objects readable by the resulting
ConfigReader
Value parameters
- f
-
the function to bind over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader bound byf.
Convert the given configuration into an instance of A if possible.
Convert the given configuration into an instance of A if possible.
Value parameters
- config
-
The configuration from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
A
Convert the given configuration into an instance of A if possible.
Convert the given configuration into an instance of A if possible.
Value parameters
- config
-
The configuration from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
A
Convert the given configuration into an instance of A if possible.
Convert the given configuration into an instance of A if possible.
Value parameters
- config
-
The configuration from which the config should be loaded
Attributes
- Returns
-
either a list of failures or an object of type
A
Maps a function over the results of this reader.
Maps a function over the results of this reader.
Type parameters
- B
-
the output type of the function
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf.
Maps a function over the results of this reader.
Maps a function over the results of this reader.
Type parameters
- B
-
the output type of the function
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf.
Maps a function over the results of this reader.
Maps a function over the results of this reader.
Type parameters
- B
-
the output type of the function
Value parameters
- f
-
the function to map over this reader
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader mapped byf.
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.
Type parameters
- AA
-
the type of the objects readable by both readers
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if it succeeds and the results ofreaderotherwise.
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.
Type parameters
- AA
-
the type of the objects readable by both readers
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if it succeeds and the results ofreaderotherwise.
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.
Type parameters
- AA
-
the type of the objects readable by both readers
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of this reader if it succeeds and the results ofreaderotherwise.
Combines this reader with another, returning both results as a pair.
Combines this reader with another, returning both results as a pair.
Type parameters
- B
-
the type of the objects readable by the provided reader
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of both readers as a pair.
Combines this reader with another, returning both results as a pair.
Combines this reader with another, returning both results as a pair.
Type parameters
- B
-
the type of the objects readable by the provided reader
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of both readers as a pair.
Combines this reader with another, returning both results as a pair.
Combines this reader with another, returning both results as a pair.
Type parameters
- B
-
the type of the objects readable by the provided reader
Value parameters
- reader
-
the reader to combine with this one
Attributes
- Returns
-
a
ConfigReaderreturning the results of both readers as a pair.