ciris
API
Generated with
ciris/ciris/ConfigDecoder

ConfigDecoder

ciris.ConfigDecoder
See theConfigDecoder companion object
sealed abstract class ConfigDecoder[A, B]

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

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.

Attributes

See also:

ConfigError.decode for creating decode errors

Concrete methods

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.

Returns a new ConfigDecoder which attempts to decode values to the specified type.

Attributes

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.

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

Attributes

final def contramap[C](f: C => A): ConfigDecoder[C, B]

Returns a new ConfigDecoder which applies the specified function on the value before decoding.

Returns a new ConfigDecoder which applies the specified function on the value before decoding.

Attributes

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.

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

Attributes

final def map[C](f: B => C): ConfigDecoder[A, C]

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

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

Attributes

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.

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

Attributes

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.

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

Attributes

final def redacted: ConfigDecoder[A, B]

Returns a new ConfigDecoder which redacts sensitive details from error messages.

Returns a new ConfigDecoder which redacts sensitive details from error messages.

Attributes

Generated with