Packages

sealed abstract class ConfigDecoder[A, B] extends AnyRef

Decodes configuration values from a first type to a second type.

Source
ConfigDecoder.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigDecoder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(key: Option[ConfigKey], value: A): Either[ConfigError, B]

    Attempts to decode the specified value to the second type.

    Attempts to decode the specified value to the second type.

    The key may be used for improved error messages. The key is present for a single configuration value, and missing for default values and composed values.

    See also

    ConfigError.decode for creating decode errors

Concrete 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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def collect[C](typeName: String)(f: PartialFunction[B, C])(implicit show: Show[B]): ConfigDecoder[A, C]

    Returns a new ConfigDecoder which successfully decodes values for which the specified partial function is defined.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def flatMap[C](f: (B) => ConfigDecoder[A, C]): ConfigDecoder[A, C]

    Returns a new ConfigDecoder using the specified function whenever the value is successfully decoded.

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def map[C](f: (B) => C): ConfigDecoder[A, C]

    Returns a new ConfigDecoder which applies the specified function on successfully decoded values.

  15. final def mapEither[C](f: (Option[ConfigKey], B) => Either[ConfigError, C]): ConfigDecoder[A, C]

    Returns a new ConfigDecoder which successfully decodes values for which the specified function returns Right.

  16. final def mapOption[C](typeName: String)(f: (B) => Option[C])(implicit show: Show[B]): ConfigDecoder[A, C]

    Returns a new ConfigDecoder which successfully decodes values for which the specified function returns Some.

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped