Type Members

1.  final case class CannotConvert(value: String, toType: String, because: String) extends FailureReason with Product with Serializable

   A general reason given for the failure of a value to be converted to a desired type.

   A general reason given for the failure of a value to be converted to a desired type.

   value

   the value that was requested to be converted

   toType

   the target type that the value was requested to be converted to

   because

   the reason why the conversion was not possible

2.  final case class CannotParse(msg: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

   A failure occurred due to the inability to parse the configuration.

   A failure occurred due to the inability to parse the configuration.

   msg

   the error message from the parser

   location

   the optional location of the failure

3.  final case class CannotReadFile(path: Path, reason: Option[Throwable]) extends ConfigReaderFailure with Product with Serializable

   A failure occurred due to the inability to read a requested file.

   A failure occurred due to the inability to read a requested file.

   path

   the file system path of the file that couldn't be read

   reason

   an optional exception thrown when trying to read the file

4.  final case class CollidingKeys(key: String, existingValue: ConfigValue) extends FailureReason with Product with Serializable

   A failure reason given when there is a collision of keys with different semantics.

   A failure reason given when there is a collision of keys with different semantics. This error is raised when a key that should be used to disambiguate a coproduct is mapped to a field in a product.

   key

   the colliding key

   existingValue

   the value of the key

5.  final case class ConfigReaderException[T](failures: ConfigReaderFailures)(implicit ct: ClassTag[T]) extends RuntimeException with Product with Serializable
6.  trait ConfigReaderFailure extends AnyRef

   A representation of a failure raised from reading a config.

   A representation of a failure raised from reading a config. The failure contains an optional file system location of the configuration that raised the failure.

7.  case class ConfigReaderFailures(head: ConfigReaderFailure, tail: List[ConfigReaderFailure]) extends Product with Serializable

   A non-empty list of ConfigReader failures

8.  case class ConfigValueLocation(url: URL, lineNumber: Int) extends Product with Serializable

   The file system location of a ConfigValue, represented by a url and a line number

   The file system location of a ConfigValue, represented by a url and a line number

   url

   the URL describing the origin of the ConfigValue

   lineNumber

   the line number (starting at 0), where the given ConfigValue definition starts

9.  case class ConvertFailure(reason: FailureReason, location: Option[ConfigValueLocation], path: String) extends ConfigReaderFailure with Product with Serializable

   A failure occurred when converting from a ConfigValue to a given type.

   A failure occurred when converting from a ConfigValue to a given type. The failure contains a path to the ConfigValue that raised the error.

   reason

   the reason for the conversion failure

   location

   the optional location of the failure

   path

   the path to the ConfigValue that raised the error

10.  final case class EmptyStringFound(typ: String) extends FailureReason with Product with Serializable

    A failure reason given when an unexpected empty string is found.

    A failure reason given when an unexpected empty string is found.

    typ

    the type that was attempted to be converted to from an empty string

11.  final case class ExceptionThrown(throwable: Throwable) extends FailureReason with Product with Serializable

    A failure reason given when an exception is thrown during a conversion.

    A failure reason given when an exception is thrown during a conversion.

    throwable

    the Throwable that was raised

12.  trait FailureReason extends AnyRef

    A representation of a reason why a value failed to be converted.

13.  final case class KeyNotFound(key: String, candidates: Set[String] = Set()) extends FailureReason with Product with Serializable

    A failure reason given when a key is missing from a ConfigObject or ConfigList.

    A failure reason given when a key is missing from a ConfigObject or ConfigList.

    key

    the key that is missing

    candidates

    a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint

14.  final case class NoValidCoproductChoiceFound(value: ConfigValue) extends FailureReason with Product with Serializable

    A failure reason given when a valid choice for a coproduct cannot be found.

    A failure reason given when a valid choice for a coproduct cannot be found.

    value

    the ConfigValue that was unable to be mapped to a coproduct choice

15.  final case class NonEmptyObjectFound(typ: String) extends FailureReason with Product with Serializable

    A failure reason given when an unexpected non-empty object is found.

    A failure reason given when an unexpected non-empty object is found. The failure happens when using EnumCoproductHint to write a config.

    typ

    the type for which a non-empty object was attempted to be written

16.  final case class ThrowableFailure(throwable: Throwable, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

    A failure occurred because an exception was thrown during the reading process.

    A failure occurred because an exception was thrown during the reading process.

    throwable

    the exception thrown

    location

    the optional location of the failure

17.  final case class UnknownKey(key: String) extends FailureReason with Product with Serializable

    A failure reason given when an unknown key is found in a ConfigObject.

    A failure reason given when an unknown key is found in a ConfigObject. The failure is raised when a key of a ConfigObject is not mapped into a field of a given type and the allowUnknownKeys property of the ProductHint for the type in question is false.

    key

    the unknown key

18.  final case class WrongSizeList(expected: Int, found: Int) extends FailureReason with Product with Serializable

    A failure reason given when a list of an unexpected size is found when attempting to read into an HList.

    A failure reason given when a list of an unexpected size is found when attempting to read into an HList.

    expected

    the expected number of elements

    found

    the number of elements found

19.  final case class WrongType(foundType: ConfigValueType, expectedTypes: Set[ConfigValueType]) extends FailureReason with Product with Serializable

    A failure reason given when a ConfigValue has the wrong type.

    A failure reason given when a ConfigValue has the wrong type.

    foundType

    the ConfigValueType that was found

    expectedTypes

    the ConfigValueTypes that were expected