Conferer.Core

Documentation

getKey :: Key -> Config -> IO (Either Text 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 providers inside the Config.

getFromConfig :: FetchFromConfig a => Key -> Config -> IO a

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

This function throws an exception if the key is not found.

(/.) :: 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

mkStandaloneProvider :: ProviderCreator -> IO Provider

Instantiate a ProviderCreator using the emptyConfig

addProvider :: ProviderCreator -> Config -> IO Config

Instantiate a Provider using an ProviderCretor 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