Trait/Object

pureconfig

ConfigReader

Related Docs: object ConfigReader | package pureconfig

Permalink

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

Linear Supertypes
AnyRef, Any
Known Subclasses
ConfigConvert
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigReader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def from(cur: ConfigCursor): Result[A]

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    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.

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

    Permalink

    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.

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

    Permalink

    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.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink

    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.

  13. def from(config: ConfigValue): Result[A]

    Permalink

    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

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink

    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.

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink

    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.

Inherited from AnyRef

Inherited from Any

Ungrouped