Documentation

The typeclass for defining the way to get values from a Config, hiding the Text based nature of the Sources and parse whatever value as the types sees fit

Some of these instances are provided in different packages to avoid the heavy dependencies.

It provides a reasonable default using Generics so most of the time user need not to implement this typeclass.

Utility only typeclass to smooth the naming differences between default values for external library settings

This typeclass is not used internally it's only here for convinience for users

Same as fetchFromConfig but adding a user defined default before fetchFromConfiging so it doesn't throw a MissingKeyError

Same as fetchFromConfig using the root key

Same as fetchFromConfigWithDefault using the root key

Helper function to implement fetchFromConfig using the IsString instance

Helper function to implement fetchFromConfig using the Read instance

Helper function to implement fetchFromConfig using some parsing function

Helper function does the plumbing of desconstructing a default into smaller defaults, which is usefull for nested fetchFromConfig.

Exception to show that some non optional Key was missing while trying to fetchFromConfig

Simplified helper function to throw a MissingRequiredKey

Simplified helper function to create a MissingRequiredKey

Exception to show that a value couldn't be parsed properly

Helper function to throw ConfigParsingError

Helper function to create a ConfigParsingError

Exception to show that the provided default had the wrong type, this is usually a programmer error and a user that configures the library can not do much to fix it.

Helper function to throw a TypeMismatchWithDefault

Helper function to create a TypeMismatchWithDefault

This type is used extensivelly as a way to point into a Source and in turn into a Config. The intended way to create them is is using mkKey.

It's a list of alphanumeric words and each Source can interpret it as it sees fit.

Concatenate two keys

A newtype wrapper for a FilePath to allow implementing FromConfig with something better than just a String

Result of a key lookup in a Config

Fetch from value from the defaults map of a Config or else return a Nothing

Fetch from value from the defaults map of a Config or else throw