Safe Haskell	None
Language	Haskell2010

System.Etc.Internal.Types

Documentation

data ConfigSource Source #

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 Source #
Methods (==) :: ConfigSource -> ConfigSource -> Bool # (/=) :: ConfigSource -> ConfigSource -> Bool #
Ord ConfigSource Source #
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 Source #
Methods showsPrec :: Int -> ConfigSource -> ShowS # show :: ConfigSource -> String # showList :: [ConfigSource] -> ShowS #

data ConfigValue Source #

Constructors

ConfigValue
Fields configSource :: Set ConfigSource
SubConfig
Fields configMap :: HashMap Text ConfigValue

Instances

Eq ConfigValue Source #
Methods (==) :: ConfigValue -> ConfigValue -> Bool # (/=) :: ConfigValue -> ConfigValue -> Bool #
Show ConfigValue Source #
Methods showsPrec :: Int -> ConfigValue -> ShowS # show :: ConfigValue -> String # showList :: [ConfigValue] -> ShowS #
Monoid ConfigValue Source #
Methods mempty :: ConfigValue # mappend :: ConfigValue -> ConfigValue -> ConfigValue # mconcat :: [ConfigValue] -> ConfigValue #

deepMerge :: ConfigValue -> ConfigValue -> ConfigValue Source #

newtype Config Source #

Constructors

Config
Fields fromConfig :: ConfigValue

Instances

Eq Config Source #
Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Monoid Config Source #
Methods mempty :: Config # mappend :: Config -> Config -> Config # mconcat :: [Config] -> Config #

isEmptySubConfig :: ConfigValue -> Bool Source #

emptySubConfig :: ConfigValue Source #

writeInSubConfig :: Text -> ConfigValue -> ConfigValue -> ConfigValue Source #

filterMaybe :: (a -> Bool) -> Maybe a -> Maybe a Source #

class IConfig config where Source #

Minimal complete definition

getConfigValue, getConfigValueWith, getAllConfigSources, getSelectedConfigSource

Methods

getConfigValue :: (MonadThrow m, FromJSON result) => [Text] -> config -> m result Source #

Fetches a configuration value from a given key, if key is not found, you may pick the failure mode via the MonadThrow interface.

example:

>>> getConfigValue ["db", "user"] config :: Maybe Text
Just "root"
>>> getConfigValue ["db", "password"] config :: Maybe Text
Nothing

getConfigValueWith :: MonadThrow m => (Value -> Parser result) -> [Text] -> config -> m result Source #

Fetches a configuration value from a given key, normally this key will point to a sub-config JSON object, which is then passed to the given JSON parser function. If key is not found, you may pick the failure mode via the MonadThrow interface.

example:

>>> import qualified Data.Aeson as JSON
>>> import qualified Data.Aeson.Types as JSON (Parser)

>>> connectInfoParser :: JSON.Value -> JSON.Parser DbConnectInfo

>>> getConfigValueWith connectInfoParser ["db"] config
Just (DbConnectInfo {...})

getAllConfigSources :: MonadThrow m => [Text] -> config -> m (Set ConfigSource) Source #

getSelectedConfigSource :: MonadThrow m => [Text] -> config -> m ConfigSource Source #

module System.Etc.Internal.Spec.Types