A general reason given for the failure of a value to be converted to a desired type.
A failure occurred due to the inability to parse the configuration.
A failure occurred due to the inability to parse the configuration.
the error message from the parser
the optional location of the failure
A failure occurred due to the inability to read a requested file.
A failure occurred due to the inability to read a requested file.
the file system path of the file that couldn't be read
an optional exception thrown when trying to read the file
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.
the colliding key
the value of the key
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.
A non-empty list of ConfigReader failures
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
the URL describing the origin of the ConfigValue
the line number (starting at 0), where the given ConfigValue definition starts
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.
the reason for the conversion failure
the optional location of the failure
the path to the ConfigValue
that raised the error
A failure reason given when an unexpected empty string is found.
A failure reason given when an unexpected empty string is found.
the type that was attempted to be converted to from an empty string
A failure reason given when an exception is thrown during a conversion.
A failure reason given when an exception is thrown during a conversion.
the Throwable
that was raised
A representation of a reason why a value failed to be converted.
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
.
the key that is missing
a set of candidate keys that might correspond to the desired key in case of a misconfigured ProductHint
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.
the ConfigValue that was unable to be mapped to a coproduct choice
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.
the type for which a non-empty object was attempted to be written
A failure occurred because an exception was thrown during the reading process.
A failure occurred because an exception was thrown during the reading process.
the exception thrown
the optional location of the failure
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
.
the unknown key
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
.
the expected number of elements
the number of elements found
A failure reason given when a string is not of the expected size.
A failure reason given when a string is not of the expected size.
the expected number of characters
the number of characters found
A failure reason given when a ConfigValue
has the wrong type.
A failure reason given when a ConfigValue
has the wrong type.
the ConfigValueType
that was found
the ConfigValueType
s that were expected
A failure occurred because a list of files to load was empty.
A failure occurred because a list of files to load was empty.
(Since version 0.10.0) loadConfigFromFiles
won't return this failure anymore
A general reason given for the failure of a value to be converted to a desired type.
the value that was requested to be converted
the target type that the value was requested to be converted to
the reason why the conversion was not possible