Conferer.Config

Public API providing Config functionality

Data

data Config

This type acts as the entry point for most of the library, it's main purpouse is to expose a uniform interface into multiple configuration sources (such as env vars, cli args, and many others including use defined ones using the Source interface)

Instances

Show Config

Defined in Conferer.Config.Internal.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Querying a config

getKey :: Key -> Config -> IO KeyLookupResult

This function runs lookups on the Config, first in Sources in order and then on the Dynamic based defaults.

data KeyLookupResult

Result of a key lookup in a Config

Constructors

MissingKey [Key]

FoundInSources Key Text

FoundInDefaults Key [Dynamic]

Instances

Show KeyLookupResult

Defined in Conferer.Config.Internal.Types

Methods

showsPrec :: Int -> KeyLookupResult -> ShowS

show :: KeyLookupResult -> String

showList :: [KeyLookupResult] -> ShowS

listSubkeys :: Key -> Config -> IO [Key]

This function lists all available keys under some key, that could be fetched successfully.

Config creation and initialization

emptyConfig :: Config

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

addSource :: SourceCreator -> Config -> IO Config

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

addSources :: [SourceCreator] -> Config -> IO Config

Instantiate several Sources using a SourceCreators and a Config and add them to the config in the order defined by the list

addDefault :: Typeable a => Key -> a -> Config -> Config

This function adds one default of a custom type to a Config

Note that unlike addDefaults this function does the toDyn so no need to do it on the user's side

addDefaults :: [(Key, Dynamic)] -> Config -> Config

This function adds defaults to a Config

addKeyMappings :: [KeyMapping] -> Config -> Config

This function adds some key mappings to a Config

removeDefault :: forall t. Typeable t => Key -> Config -> Config

This function removes a default from a Config, this is the oposite of addDefault, it deletes the first element of matching type in a certain Key.

type Defaults = [(Key, Dynamic)]

Re-Exports

module Conferer.Key

(&) :: a -> (a -> b) -> b infixl 1

& is a reverse application operator. This provides notational convenience. Its precedence is one higher than that of the forward application operator $, which allows & to be nested in $.

>>> 5 & (+1) & show
"6"

Since: base-4.8.0.0