OptionConfigReader

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

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

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

   

   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

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

   

   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

8. def emap[B](f: (Option[T]) ⇒ 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

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

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def flatMap[B](f: (Option[T]) ⇒ 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

13. def from(cur: ConfigCursor): Either[ConfigReaderFailures, Option[T]]

    

    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

    OptionConfigReader → ConfigReader

14. def from(config: ConfigValue): Either[ConfigReaderFailures, Option[T]]

    

    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

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

    

    Definition Classes

    AnyRef → Any

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. def map[B](f: (Option[T]) ⇒ 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

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

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. def orElse[AA >: Option[T], 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

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

    

    Definition Classes

    AnyRef

24. def toString(): String

    

    Definition Classes

    AnyRef → Any

25. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. def zip[B](reader: ConfigReader[B]): ConfigReader[(Option[T], 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