ConfigError

ciris.ConfigError
See theConfigError companion class
object ConfigError

Attributes

Companion
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

final def apply(message: => String): ConfigError

Returns a new ConfigError using the specified message.

Returns a new ConfigError using the specified message.

If the specified message might contain sensitive details, then use ConfigError.sensitive instead to create an error which is capable of redacting sensitive details.

Attributes

final def decode[A](typeName: String, key: Option[ConfigKey], value: A)(implicit show: Show[A]): ConfigError

Returns a new ConfigError for when the specified value could not be decoded.

Returns a new ConfigError for when the specified value could not be decoded.

Attributes

final def sensitive(message: => String, redactedMessage: => String): ConfigError

Returns a new ConfigError using the specified message and redacted message.

Returns a new ConfigError using the specified message and redacted message.

The specified message is used in the returned ConfigError. Whenever ConfigError#redacted is invoked on the returned instance, a new ConfigError is returned which instead uses the redacted message.

Attributes

Implicits

Implicits

final implicit val configErrorEq: Eq[ConfigError]

Attributes

final implicit val configErrorShow: Show[ConfigError]

Attributes