Safe Haskell	None
Language	Haskell2010

System.Etc.Internal.Types

Documentation

class IConfig config where #

Minimal complete definition

getConfigValue, getConfigValueWith, getAllConfigSources, getSelectedConfigSource

Methods

getConfigValue #

Arguments

:: (MonadThrow m, FromJSON result)
=> [Text]	Key to fetch from config map
-> config	Config record
-> m result

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 #

Arguments

:: MonadThrow m
=> (Value -> Parser result)	JSON Parser function
-> [Text]	Key to fetch from config map
-> config	Config record
-> m result

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) #

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

Instances

IConfig Config #

Instance details

Defined in System.Etc.Internal.Config

Methods

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

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

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

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

newtype Config #

Constructors

Config
Fields fromConfig :: ConfigValue

Instances

Eq Config #
Instance details Defined in System.Etc.Internal.Types Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config #
Instance details Defined in System.Etc.Internal.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Semigroup Config #
Instance details Defined in System.Etc.Internal.Types Methods (<>) :: Config -> Config -> Config # sconcat :: NonEmpty Config -> Config # stimes :: Integral b => b -> Config -> Config #
Monoid Config #
Instance details Defined in System.Etc.Internal.Types Methods mempty :: Config # mappend :: Config -> Config -> Config # mconcat :: [Config] -> Config #
IConfig Config #
Instance details Defined in System.Etc.Internal.Config Methods getConfigValue :: (MonadThrow m, FromJSON result) => [Text] -> Config -> m result # getConfigValueWith :: MonadThrow m => (Value -> Parser result) -> [Text] -> Config -> m result # getAllConfigSources :: MonadThrow m => [Text] -> Config -> m (Set ConfigSource) # getSelectedConfigSource :: MonadThrow m => [Text] -> Config -> m ConfigSource #

data ConfigValue #

Constructors

ConfigValue
Fields configSource :: !(Set ConfigSource)
SubConfig
Fields configMap :: !(HashMap Text ConfigValue)

Instances

Eq ConfigValue #
Instance details Defined in System.Etc.Internal.Types Methods (==) :: ConfigValue -> ConfigValue -> Bool # (/=) :: ConfigValue -> ConfigValue -> Bool #
Show ConfigValue #
Instance details Defined in System.Etc.Internal.Types Methods showsPrec :: Int -> ConfigValue -> ShowS # show :: ConfigValue -> String # showList :: [ConfigValue] -> ShowS #
Semigroup ConfigValue #
Instance details Defined in System.Etc.Internal.Types Methods (<>) :: ConfigValue -> ConfigValue -> ConfigValue # sconcat :: NonEmpty ConfigValue -> ConfigValue # stimes :: Integral b => b -> ConfigValue -> ConfigValue #
Monoid ConfigValue #
Instance details Defined in System.Etc.Internal.Types Methods mempty :: ConfigValue # mappend :: ConfigValue -> ConfigValue -> ConfigValue # mconcat :: [ConfigValue] -> ConfigValue #

data ConfigSource #

Constructors

File
Fields configIndex :: !Int filepath :: !FileSource value :: !(Value Value)
Env
Fields envVar :: !Text value :: !(Value Value)
Cli
Fields value :: !(Value Value)
Default
Fields value :: !(Value Value)
None

Instances

Eq ConfigSource #
Instance details Defined in System.Etc.Internal.Types Methods (==) :: ConfigSource -> ConfigSource -> Bool # (/=) :: ConfigSource -> ConfigSource -> Bool #
Ord ConfigSource #
Instance details Defined in System.Etc.Internal.Types 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 #
Instance details Defined in System.Etc.Internal.Types Methods showsPrec :: Int -> ConfigSource -> ShowS # show :: ConfigSource -> String # showList :: [ConfigSource] -> ShowS #

data FileSource #

Constructors

FilePathSource
Fields fileSourcePath :: !Text
EnvVarFileSource
Fields fileSourceEnvVar :: !Text fileSourcePath :: !Text

Instances

Eq FileSource #
Instance details Defined in System.Etc.Internal.Types Methods (==) :: FileSource -> FileSource -> Bool # (/=) :: FileSource -> FileSource -> Bool #
Show FileSource #
Instance details Defined in System.Etc.Internal.Types Methods showsPrec :: Int -> FileSource -> ShowS # show :: FileSource -> String # showList :: [FileSource] -> ShowS #

data Value a #

Constructors

Plain
Fields fromValue :: !a
Sensitive
Fields fromValue :: !a

Instances

Functor Value #
Instance details Defined in System.Etc.Internal.Types Methods fmap :: (a -> b) -> Value a -> Value b # (<$) :: a -> Value b -> Value a #
Applicative Value #
Instance details Defined in System.Etc.Internal.Types Methods pure :: a -> Value a # (<>) :: Value (a -> b) -> Value a -> Value b # liftA2 :: (a -> b -> c) -> Value a -> Value b -> Value c # (>) :: Value a -> Value b -> Value b # (<*) :: Value a -> Value b -> Value a #
Eq a => Eq (Value a) #
Instance details Defined in System.Etc.Internal.Types Methods (==) :: Value a -> Value a -> Bool # (/=) :: Value a -> Value a -> Bool #
Ord a => Ord (Value a) #
Instance details Defined in System.Etc.Internal.Types Methods compare :: Value a -> Value a -> Ordering # (<) :: Value a -> Value a -> Bool # (<=) :: Value a -> Value a -> Bool # (>) :: Value a -> Value a -> Bool # (>=) :: Value a -> Value a -> Bool # max :: Value a -> Value a -> Value a # min :: Value a -> Value a -> Value a #
Show a => Show (Value a) #
Instance details Defined in System.Etc.Internal.Types Methods showsPrec :: Int -> Value a -> ShowS # show :: Value a -> String # showList :: [Value a] -> ShowS #
IsString a => IsString (Value a) #
Instance details Defined in System.Etc.Internal.Types Methods fromString :: String -> Value a #
Generic (Value a) #
Instance details Defined in System.Etc.Internal.Types Associated Types type Rep (Value a) :: * -> * # Methods from :: Value a -> Rep (Value a) x # to :: Rep (Value a) x -> Value a #
type Rep (Value a) #
Instance details Defined in System.Etc.Internal.Types type Rep (Value a) = D1 (MetaData "Value" "System.Etc.Internal.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "Plain" PrefixI True) (S1 (MetaSel (Just "fromValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 a)) :+: C1 (MetaCons "Sensitive" PrefixI True) (S1 (MetaSel (Just "fromValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 a)))

markAsSensitive :: Bool -> a -> Value a #

deepMerge :: ConfigValue -> ConfigValue -> ConfigValue #

isEmptySubConfig :: ConfigValue -> Bool #

emptySubConfig :: ConfigValue #

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

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

data ConfigurationError #

Constructors

InvalidConfiguration !(Maybe Text) !Text
InvalidConfigKeyPath ![Text]
ConfigurationFileNotFound !Text

Instances

Show ConfigurationError #
Instance details Defined in System.Etc.Internal.Spec.Types Methods showsPrec :: Int -> ConfigurationError -> ShowS # show :: ConfigurationError -> String # showList :: [ConfigurationError] -> ShowS #
Generic ConfigurationError #
Instance details Defined in System.Etc.Internal.Spec.Types Associated Types type Rep ConfigurationError :: * -> * # Methods from :: ConfigurationError -> Rep ConfigurationError x # to :: Rep ConfigurationError x -> ConfigurationError #
Exception ConfigurationError #
Instance details Defined in System.Etc.Internal.Spec.Types Methods toException :: ConfigurationError -> SomeException # fromException :: SomeException -> Maybe ConfigurationError # displayException :: ConfigurationError -> String #
type Rep ConfigurationError #
Instance details Defined in System.Etc.Internal.Spec.Types type Rep ConfigurationError = D1 (MetaData "ConfigurationError" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "InvalidConfiguration" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: (C1 (MetaCons "InvalidConfigKeyPath" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) :+: C1 (MetaCons "ConfigurationFileNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))