Conferer.Core

Documentation

getKey :: Key -> Config -> IO (Maybe Text)

Most Basic function to interact directly with a Config. It always returns Text in the case of success and implements the logic to traverse sources inside the Config.

getFromConfig :: forall a. (Typeable a, FromConfig a, DefaultConfig a) => Key -> Config -> IO a

Fetch a value from a config under some specific key that's parsed using the FromConfig instance, and as a default it uses the value from DefaultConfig.

Notes: - This function may throw an exception if parsing fails for any subkey

getFromRootConfig :: forall a. (Typeable a, FromConfig a, DefaultConfig a) => Config -> IO a

Same as getFromConfig using the root key

Notes: - This function may throw an exception if parsing fails for any subkey

getFromConfigWithDefault :: forall a. (Typeable a, FromConfig a) => Key -> Config -> a -> IO a

Same as getFromConfig but with a user defined default (instead of DefaultConfig instance)

Useful for fetching primitive types

safeGetFromConfig :: forall a. (Typeable a, FromConfig a, DefaultConfig a) => Key -> Config -> IO (Maybe a)

Fetch a value from a config key that's parsed using the FromConfig instance.

Note: This function does not use default so the value must be fully defined by the config only, meaning using this function for many records will always result in Nothing (if the record contains a value that can never be retrieved like a function)

safeGetFromConfigWithDefault :: forall a. (Typeable a, FromConfig a) => Key -> Config -> a -> IO (Maybe a)

Same as safeGetFromConfig but with a user defined default

(/.) :: Key -> Key -> Key

Create a new Key by concatenating two existing keys.

emptyConfig :: Config

The empty configuration, this Config is used as the base for most config creating functions.

withDefaults :: [(Key, Text)] -> Config -> Config

mkStandaloneSource :: SourceCreator -> IO Source

Instantiate a SourceCreator using the emptyConfig

addSource :: SourceCreator -> Config -> IO Config

Instantiate a Source using an SourceCretor and a Config and add to the config

unsafeGetKey :: Key -> Config -> IO Text

Same as getKey but it throws if the Key isn't found