System.Etc

Config

Use this functions to fetch values from the Etc.Config and cast them to types that make sense in your program

data Config

Instances

Eq Config

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Show Config

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Monoid Config

Methods

mempty :: Config

mappend :: Config -> Config -> Config

mconcat :: [Config] -> Config

getConfigValue :: (MonadThrow m, FromJSON result) => [Text] -> Config -> m result

getConfigValueWith :: MonadThrow m => (Value -> Parser a) -> [Text] -> Config -> m a

getSelectedConfigSource :: MonadThrow m => [Text] -> Config -> m ConfigSource

getAllConfigSources :: MonadThrow m => [Text] -> Config -> m (Set ConfigSource)

ConfigSpec

Use this functions to read the configuration spec. Remember you can use JSON or YAML(*) filepaths

• The yaml cabal flag must be used to support yaml syntax

data ConfigSource

Constructors

File

Fields

• configIndex :: Int
• filepath :: Text
• value :: Value

Env

Fields

• envVar :: Text
• value :: Value

Cli

Fields

• value :: Value

Default

Fields

• value :: Value

None

Instances

Eq ConfigSource

Methods

(==) :: ConfigSource -> ConfigSource -> Bool

(/=) :: ConfigSource -> ConfigSource -> Bool

Ord ConfigSource

Methods

compare :: ConfigSource -> ConfigSource -> Ordering

(<) :: ConfigSource -> ConfigSource -> Bool

(<=) :: ConfigSource -> ConfigSource -> Bool

(>) :: ConfigSource -> ConfigSource -> Bool

(>=) :: ConfigSource -> ConfigSource -> Bool

max :: ConfigSource -> ConfigSource -> ConfigSource

min :: ConfigSource -> ConfigSource -> ConfigSource

Show ConfigSource

Methods

showsPrec :: Int -> ConfigSource -> ShowS

show :: ConfigSource -> String

showList :: [ConfigSource] -> ShowS

data ConfigValue

Instances

Eq ConfigValue

Methods

(==) :: ConfigValue -> ConfigValue -> Bool

(/=) :: ConfigValue -> ConfigValue -> Bool

Show ConfigValue

Methods

showsPrec :: Int -> ConfigValue -> ShowS

show :: ConfigValue -> String

showList :: [ConfigValue] -> ShowS

Monoid ConfigValue

Methods

mempty :: ConfigValue

mappend :: ConfigValue -> ConfigValue -> ConfigValue

mconcat :: [ConfigValue] -> ConfigValue

data ConfigSpec cmd

Instances

Eq cmd => Eq (ConfigSpec cmd)

Methods

(==) :: ConfigSpec cmd -> ConfigSpec cmd -> Bool

(/=) :: ConfigSpec cmd -> ConfigSpec cmd -> Bool

Show cmd => Show (ConfigSpec cmd)

Methods

showsPrec :: Int -> ConfigSpec cmd -> ShowS

show :: ConfigSpec cmd -> String

showList :: [ConfigSpec cmd] -> ShowS

FromJSON cmd => FromJSON (ConfigSpec cmd)

Methods

parseJSON :: Value -> Parser (ConfigSpec cmd)

parseJSONList :: Value -> Parser [ConfigSpec cmd]

data ConfigurationError

Constructors

InvalidConfiguration Text

InvalidConfigKeyPath [Text]

ConfigurationFileNotFound Text

Instances

Show ConfigurationError

Methods

showsPrec :: Int -> ConfigurationError -> ShowS

show :: ConfigurationError -> String

showList :: [ConfigurationError] -> ShowS

Exception ConfigurationError

Methods

toException :: ConfigurationError -> SomeException

fromException :: SomeException -> Maybe ConfigurationError

displayException :: ConfigurationError -> String

parseConfigSpec

Arguments

:: (MonadCatch m, FromJSON cmd)

=> Text

Text to be parsed

-> m (ConfigSpec cmd)

returns ConfigSpec

Parses a text input into a ConfigSpec, input can be JSON or YAML (if cabal flag is set).

readConfigSpec

Arguments

:: FromJSON cmd

=> Text

Filepath where contents are going to be read from and parsed

-> IO (ConfigSpec cmd)

returns ConfigSpec

Reads contents of a file and parses into a ConfigSpec, file contents can be either JSON or YAML (if cabal flag is set).

Resolvers

Use this functions to gather configuration values from different sources (environment variables, command lines or files). Then compose results together using the mappend function

resolveDefault

Arguments

:: ConfigSpec cmd

ConfigSpec

-> Config

returns Configuration Map with default values included

Gathers all default values from the etc/spec entries inside a ConfigSpec

resolveFiles

Arguments

:: ConfigSpec cmd

Config Spec

-> IO (Config, Vector SomeException)

Configuration Map with all values from files filled in and a list of warnings

Gathers configuration values from a list of files specified on the etc/filepaths entry of a Config Spec. This will return a Configuration Map with values from all filepaths merged in, and a list of errors in case there was an error reading one of the filepaths.

resolveEnvPure

Arguments

:: ConfigSpec cmd

ConfigSpec

-> [(Text, Text)]

Environment Variable tuples

-> Config

returns Configuration Map with Environment Variables values filled in

Gathers all OS Environment Variable values (env entries) from the etc/spec entries inside a ConfigSpec. This version of the function gathers the input from a list of tuples rather than the OS.

resolveEnv

Arguments

:: ConfigSpec cmd

Config Spec

-> IO Config

returns Configuration Map with Environment Variables values filled in

Gathers all OS Environment Variable values (env entries) from the etc/spec entries inside a ConfigSpec.