ConfigConvert

Abstract Value Members

abstract def from(cur: ConfigCursor): Either[ConfigReaderFailures, 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

Definition Classes
ConfigReader
abstract def to(a: A): ConfigValue

Converts a type A to a ConfigValue.
Converts a type A to a ConfigValue.
a
The instance of A to convert
returns
The ConfigValue obtained from the A instance

Definition Classes
ConfigWriter

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contramap[B](f: (B) ⇒ A): ConfigWriter[B]

Applies a function to values before passing them to this writer.
Applies a function to values before passing them to this writer.
B
the input type of the function
f
the function to apply to input values
returns
a ConfigWriter that writes the results of this writer when the input values are mapped using f.

Definition Classes
ConfigWriter
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 using f.

Definition Classes
ConfigReader
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 using f.

Definition Classes
ConfigReader
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 by f, with the resulting Either flattened as a success or failure.

Definition Classes
ConfigReader
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.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 by f.

Definition Classes
ConfigReader
def from(config: ConfigValue): Either[ConfigReaderFailures, 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

Definition Classes
ConfigReader
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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 by f.

Definition Classes
ConfigReader
def mapConfig(f: (ConfigValue) ⇒ ConfigValue): ConfigWriter[A]

Maps a function over the results of this writer.
Maps a function over the results of this writer.
f
the function to map over this writer
returns
a ConfigWriter returning the results of this writer mapped by f.

Definition Classes
ConfigWriter
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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 of reader otherwise.

Definition Classes
ConfigReader
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( ... )
def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): ConfigConvert[B]

Transforms the values read and written by this ConfigConvert using two functions.
Transforms the values read and written by this ConfigConvert using two functions.
B
the type of the returned ConfigConvert
f
the function applied to values after they are read
g
the function applied to values before they are written
returns
a ConfigConvert that reads and writes values of type B by applying f and g on read and write, respectively.
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.

Definition Classes
ConfigReader

Related Docs: object ConfigConvert | package pureconfig

trait ConfigConvert[A] extends ConfigReader[A] with ConfigWriter[A]

Abstract Value Members

abstract def from(cur: ConfigCursor): Either[ConfigReaderFailures, A]

abstract def to(a: A): ConfigValue

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def contramap[B](f: (B) ⇒ A): ConfigWriter[B]

def contramapConfig(f: (ConfigValue) ⇒ ConfigValue): ConfigReader[A]

def contramapCursor(f: (ConfigCursor) ⇒ ConfigCursor): ConfigReader[A]

def emap[B](f: (A) ⇒ Either[FailureReason, B]): ConfigReader[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flatMap[B](f: (A) ⇒ ConfigReader[B]): ConfigReader[B]

def from(config: ConfigValue): Either[ConfigReaderFailures, A]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[B](f: (A) ⇒ B): ConfigReader[B]

def mapConfig(f: (ConfigValue) ⇒ ConfigValue): ConfigWriter[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def orElse[AA >: A, B <: AA](reader: ⇒ ConfigReader[B]): ConfigReader[AA]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): ConfigConvert[B]

def zip[B](reader: ConfigReader[B]): ConfigReader[(A, B)]

Inherited from ConfigWriter[A]

Inherited from ConfigReader[A]

Inherited from AnyRef

Inherited from Any

Ungrouped