error

Type Members

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

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
the path to the value that couldn't be converted
final case class CannotConvertNull(candidates: Set[String] = Set()) extends ConvertFailure with Product with Serializable

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 at the root (i.e. an empty string).
candidates
a set of candidate keys that might map to the desired value in case of a misconfigured ProductHint
final case class CannotParse(msg: String, location: Option[ConfigValueLocation]) extends ConfigReaderFailure with Product with Serializable

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
final case class CannotReadFile(path: Path, reason: Option[Throwable]) extends ConfigReaderFailure with Product with Serializable

A failure representing the inability to read a requested file.
final case class CollidingKeys(key: String, existingValue: ConfigValue, location: Option[ConfigValueLocation]) extends ConvertFailure with Product with Serializable

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
final case class ConfigReaderException[T](failures: ConfigReaderFailures)(implicit ct: ClassTag[T]) extends RuntimeException with Product with Serializable
abstract class ConfigReaderFailure extends AnyRef

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 file system location of the configuration that raised the failure.
case class ConfigReaderFailures(head: ConfigReaderFailure, tail: List[ConfigReaderFailure]) extends Product with Serializable

A non-empty list of ConfigReader failures
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
abstract class ConvertFailure extends ConfigReaderFailure

A representation of a failure that might be raised from converting from a ConfigValue to a given type.
A representation of a failure that might be raised from converting from a ConfigValue to a given type. The failure contains a path to the ConfigValue that raised the error.
final case class EmptyStringFound(typ: String, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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
the path to the value which was an unexpected empty string
final case class KeyNotFound(key: String, location: Option[ConfigValueLocation], candidates: Set[String] = Set()) extends ConvertFailure with Product with Serializable

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
candidates
a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint
final case class NoValidCoproductChoiceFound(value: ConfigValue, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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
the path to the value who doesn't have a valid choice for a coproduct
final case class NonEmptyObjectFound(typ: String, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

A failure representing an unexpected non-empty object when using EnumCoproductHint to write a config.
A failure representing an unexpected non-empty object when using EnumCoproductHint to write a config.
typ
the type for which a non-empty object was attempted to be written
location
an optional location of the ConfigValue that raised the failure
path
the path to the value which was an unexpected empty string
final case class ThrowableFailure(throwable: Throwable, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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
the path to the value that raised the Throwable
final case class UnknownKey(key: String, location: Option[ConfigValueLocation]) extends ConvertFailure with Product with Serializable

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
final case class WrongSizeList(expected: Int, found: Int, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

A failure representing that a list of an unexpected size was found when attempting to read into an HList.
A failure representing that a list of an unexpected size was found when attempting to read into an HList.
expected
the expected number of elements
found
the number of elements found
location
an optional location of the ConfigValue that raised the failure
path
the path to the value which was a list of an unexpected size
final case class WrongType(foundType: ConfigValueType, expectedTypes: Set[ConfigValueType], location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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
the path to the value that had a wrong type

Value Members

object CannotConvertNull extends Serializable
object ConfigReaderException extends Serializable
object ConfigReaderFailures extends Serializable
object ConfigValueLocation extends Serializable

package error

Type Members

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

final case class CannotConvertNull(candidates: Set[String] = Set()) extends ConvertFailure with Product with Serializable

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

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

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

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

abstract class ConfigReaderFailure extends AnyRef

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

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

abstract class ConvertFailure extends ConfigReaderFailure

final case class EmptyStringFound(typ: String, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

final case class KeyNotFound(key: String, location: Option[ConfigValueLocation], candidates: Set[String] = Set()) extends ConvertFailure with Product with Serializable

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

final case class NonEmptyObjectFound(typ: String, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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

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

final case class WrongSizeList(expected: Int, found: Int, location: Option[ConfigValueLocation], path: String) extends ConvertFailure with Product with Serializable

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

Value Members

object CannotConvertNull extends Serializable

object ConfigReaderException extends Serializable

object ConfigReaderFailures extends Serializable

object ConfigValueLocation extends Serializable

Ungrouped