Package

pureconfig

error

Permalink

package error

Visibility
  1. Public
  2. All

Type Members

  1. final case class CannotConvert(value: String, toType: String, because: String, location: Option[ConfigValueLocation], path: Option[String]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing the inability to convert a given value to a desired type.

    A failure representing the inability to convert a given value 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

    location

    an optional location of the ConfigValue that raised the failure

    path

    an optional path to the value that couldn't be converted

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

    Permalink

    A failure representing the inability to parse the configuration.

    A failure representing the inability to parse the configuration.

    msg

    the error message from the parser

    location

    an optional location of the ConfigValue that raised the failure

  3. final case class CollidingKeys(key: String, existingValue: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing a collision of keys with different semantics.

    A failure representing 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

    location

    an optional location of the ConfigValue that raised the failure

  4. case class CollidingKeysException(key: String, existingValue: String) extends IllegalArgumentException with Product with Serializable

    Permalink
  5. final case class ConfigReaderException[T](failures: ConfigReaderFailures)(implicit ct: ClassTag[T]) extends RuntimeException with Product with Serializable

    Permalink
  6. sealed abstract class ConfigReaderFailure extends AnyRef

    Permalink

    A representation of a failure that might be raised from reading a ConfigValue.

    A representation of a failure that might be raised from reading a ConfigValue. The failure contains an optional location of the ConfigValue that raised the error.

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

    Permalink

    A non-empty list of ConfigReader failures

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

    Permalink

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

    The physical 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. final case class EmptyStringFound(typ: String, location: Option[ConfigValueLocation], path: Option[String]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing an unexpected empty string

    A failure representing an unexpected empty string

    typ

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

    location

    an optional location of the ConfigValue that raised the failure

    path

    an optional path to the value which was an unexpected empty string

  10. final case class KeyNotFound(key: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing a key missing from a ConfigObject.

    A failure representing a key missing from a ConfigObject.

    key

    the key that is missing

    location

    an optional location of the ConfigValue that raised the failure

  11. final case class NoValidCoproductChoiceFound(value: ConfigValue, location: Option[ConfigValueLocation], path: Option[String]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing the inability to find a valid choice for a given coproduct.

    A failure representing the inability to find a valid choice for a given coproduct.

    value

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

    location

    an optional location of the ConfigValue that raised the failure

    path

    an optional path to the value who doesn't have a valid choice for a coproduct

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

    Permalink

    A failure that resulted in a Throwable being raised.

    A failure that resulted in a Throwable being raised.

    throwable

    the Throwable that was raised

    location

    an optional location of the ConfigValue that raised the failure

    path

    an optional path to the value that raised the Throwable

  13. final case class UnknownKey(key: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing the presence of an unknown key in a ConfigObject.

    A failure representing the presence of an unknown key in a ConfigObject. This error 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

    location

    an optional location of the ConfigValue that raised the failure

  14. final case class WrongType(foundType: ConfigValueType, expectedTypes: Set[ConfigValueType], location: Option[ConfigValueLocation], path: Option[String]) extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing a wrong type of a given ConfigValue.

    A failure representing a wrong type of a given ConfigValue.

    foundType

    the ConfigValueType that was found

    expectedTypes

    the ConfigValueTypes that were expected

    location

    an optional location of the ConfigValue that raised the failure

    path

    an optional path to the value that had a wrong type

Value Members

  1. object CannotConvertNull extends ConfigReaderFailure with Product with Serializable

    Permalink

    A failure representing the inability to convert a null value.

    A failure representing the inability to convert a null value. Since a null represents a missing value, the location of this failure is always None.

  2. object ConfigReaderException extends Serializable

    Permalink
  3. object ConfigReaderFailures extends Serializable

    Permalink
  4. object ConfigValueLocation extends Serializable

    Permalink

Ungrouped