sealed abstract class ConfigDecoder[A, B] extends AnyRef
Decodes configuration values from a first type to a second type.
- Source
- ConfigDecoder.scala
- Alphabetic
- By Inheritance
- ConfigDecoder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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
- 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 as[C](implicit decoder: ConfigDecoder[B, C]): ConfigDecoder[A, C]
Returns a new ConfigDecoder which attempts to decode values to the specified type.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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.
- final def contramap[C](f: (C) => A): ConfigDecoder[C, B]
Returns a new ConfigDecoder which applies the specified function on the value before decoding.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def map[C](f: (B) => C): ConfigDecoder[A, C]
Returns a new ConfigDecoder which applies the specified function on successfully decoded values.
- 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. - 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. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def redacted: ConfigDecoder[A, B]
Returns a new ConfigDecoder which redacts sensitive details from error messages.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)