etc-0.4.0.3: Declarative configuration spec for Haskell projects

Safe HaskellNone
LanguageHaskell2010

System.Etc.Internal.Spec.Types

Documentation

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

data CliOptValueType #

Constructors

StringOpt 
NumberOpt 
SwitchOpt 
Instances
Eq CliOptValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliOptValueType -> CliOptValueType -> Bool #

(/=) :: CliOptValueType -> CliOptValueType -> Bool #

Show CliOptValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliOptValueType -> ShowS #

show :: CliOptValueType -> String #

showList :: [CliOptValueType] -> ShowS #

Generic CliOptValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep CliOptValueType :: * -> * #

Methods

from :: CliOptValueType -> Rep CliOptValueType x #

to :: Rep CliOptValueType x -> CliOptValueType #

type Rep CliOptValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep CliOptValueType = D1 (MetaData "CliOptValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "StringOpt" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "NumberOpt" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "SwitchOpt" PrefixI False) (U1 :: * -> *)))

data CliArgValueType #

Constructors

StringArg 
NumberArg 
Instances
Eq CliArgValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliArgValueType -> CliArgValueType -> Bool #

(/=) :: CliArgValueType -> CliArgValueType -> Bool #

Show CliArgValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliArgValueType -> ShowS #

show :: CliArgValueType -> String #

showList :: [CliArgValueType] -> ShowS #

Generic CliArgValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep CliArgValueType :: * -> * #

Methods

from :: CliArgValueType -> Rep CliArgValueType x #

to :: Rep CliArgValueType x -> CliArgValueType #

type Rep CliArgValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep CliArgValueType = D1 (MetaData "CliArgValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "StringArg" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NumberArg" PrefixI False) (U1 :: * -> *))

data CliEntryMetadata #

Constructors

Opt 

Fields

Arg 

Fields

Instances
Eq CliEntryMetadata # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliEntryMetadata -> CliEntryMetadata -> Bool #

(/=) :: CliEntryMetadata -> CliEntryMetadata -> Bool #

Show CliEntryMetadata # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliEntryMetadata -> ShowS #

show :: CliEntryMetadata -> String #

showList :: [CliEntryMetadata] -> ShowS #

Generic CliEntryMetadata # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep CliEntryMetadata :: * -> * #

Methods

from :: CliEntryMetadata -> Rep CliEntryMetadata x #

to :: Rep CliEntryMetadata x -> CliEntryMetadata #

type Rep CliEntryMetadata # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep CliEntryMetadata = D1 (MetaData "CliEntryMetadata" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "Opt" PrefixI True) ((S1 (MetaSel (Just "optLong") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "optShort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "optMetavar") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "optHelp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "optRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))) :+: C1 (MetaCons "Arg" PrefixI True) (S1 (MetaSel (Just "argMetavar") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "optRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))

data CliEntrySpec cmd #

Constructors

CmdEntry 

Fields

PlainEntry 

Fields

Instances
Eq cmd => Eq (CliEntrySpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliEntrySpec cmd -> CliEntrySpec cmd -> Bool #

(/=) :: CliEntrySpec cmd -> CliEntrySpec cmd -> Bool #

Show cmd => Show (CliEntrySpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliEntrySpec cmd -> ShowS #

show :: CliEntrySpec cmd -> String #

showList :: [CliEntrySpec cmd] -> ShowS #

Generic (CliEntrySpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep (CliEntrySpec cmd) :: * -> * #

Methods

from :: CliEntrySpec cmd -> Rep (CliEntrySpec cmd) x #

to :: Rep (CliEntrySpec cmd) x -> CliEntrySpec cmd #

FromJSON cmd => FromJSON (CliEntrySpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser (CliEntrySpec cmd) #

parseJSONList :: Value -> Parser [CliEntrySpec cmd] #

type Rep (CliEntrySpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep (CliEntrySpec cmd) = D1 (MetaData "CliEntrySpec" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "CmdEntry" PrefixI True) (S1 (MetaSel (Just "cliEntryCmdValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector cmd)) :*: S1 (MetaSel (Just "cliEntryMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CliEntryMetadata)) :+: C1 (MetaCons "PlainEntry" PrefixI True) (S1 (MetaSel (Just "cliEntryMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CliEntryMetadata)))

data CliCmdSpec #

Constructors

CliCmdSpec 

Fields

Instances
Eq CliCmdSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliCmdSpec -> CliCmdSpec -> Bool #

(/=) :: CliCmdSpec -> CliCmdSpec -> Bool #

Show CliCmdSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliCmdSpec -> ShowS #

show :: CliCmdSpec -> String #

showList :: [CliCmdSpec] -> ShowS #

Generic CliCmdSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep CliCmdSpec :: * -> * #

Methods

from :: CliCmdSpec -> Rep CliCmdSpec x #

to :: Rep CliCmdSpec x -> CliCmdSpec #

FromJSON CliCmdSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser CliCmdSpec #

parseJSONList :: Value -> Parser [CliCmdSpec] #

type Rep CliCmdSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep CliCmdSpec = D1 (MetaData "CliCmdSpec" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "CliCmdSpec" PrefixI True) (S1 (MetaSel (Just "cliCmdDesc") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "cliCmdHeader") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

data ConfigSources cmd #

Constructors

ConfigSources 

Fields

Instances
Eq cmd => Eq (ConfigSources cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: ConfigSources cmd -> ConfigSources cmd -> Bool #

(/=) :: ConfigSources cmd -> ConfigSources cmd -> Bool #

Show cmd => Show (ConfigSources cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> ConfigSources cmd -> ShowS #

show :: ConfigSources cmd -> String #

showList :: [ConfigSources cmd] -> ShowS #

Generic (ConfigSources cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep (ConfigSources cmd) :: * -> * #

Methods

from :: ConfigSources cmd -> Rep (ConfigSources cmd) x #

to :: Rep (ConfigSources cmd) x -> ConfigSources cmd #

type Rep (ConfigSources cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep (ConfigSources cmd) = D1 (MetaData "ConfigSources" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "ConfigSources" PrefixI True) (S1 (MetaSel (Just "envVar") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "cliEntry") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (CliEntrySpec cmd)))))

data SingleConfigValueType #

Constructors

CVTString 
CVTNumber 
CVTBool 
CVTObject 
Instances
Eq SingleConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: SingleConfigValueType -> SingleConfigValueType -> Bool #

(/=) :: SingleConfigValueType -> SingleConfigValueType -> Bool #

Show SingleConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> SingleConfigValueType -> ShowS #

show :: SingleConfigValueType -> String #

showList :: [SingleConfigValueType] -> ShowS #

Generic SingleConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep SingleConfigValueType :: * -> * #

Methods

from :: SingleConfigValueType -> Rep SingleConfigValueType x #

to :: Rep SingleConfigValueType x -> SingleConfigValueType #

Display SingleConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

display :: SingleConfigValueType -> Utf8Builder #

type Rep SingleConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep SingleConfigValueType = D1 (MetaData "SingleConfigValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) ((C1 (MetaCons "CVTString" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CVTNumber" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "CVTBool" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "CVTObject" PrefixI False) (U1 :: * -> *)))

data ConfigValueType #

Constructors

CVTSingle !SingleConfigValueType 
CVTArray !SingleConfigValueType 
Instances
Eq ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: ConfigValueType -> ConfigValueType -> Bool #

(/=) :: ConfigValueType -> ConfigValueType -> Bool #

Show ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> ConfigValueType -> ShowS #

show :: ConfigValueType -> String #

showList :: [ConfigValueType] -> ShowS #

Generic ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep ConfigValueType :: * -> * #

Methods

from :: ConfigValueType -> Rep ConfigValueType x #

to :: Rep ConfigValueType x -> ConfigValueType #

FromJSON ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser ConfigValueType #

parseJSONList :: Value -> Parser [ConfigValueType] #

Display ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

display :: ConfigValueType -> Utf8Builder #

type Rep ConfigValueType # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep ConfigValueType = D1 (MetaData "ConfigValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "CVTSingle" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SingleConfigValueType)) :+: C1 (MetaCons "CVTArray" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SingleConfigValueType)))

data ConfigValue cmd #

Constructors

ConfigValue 

Fields

SubConfig 

Fields

Instances
Eq cmd => Eq (ConfigValue cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

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

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

Show cmd => Show (ConfigValue cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> ConfigValue cmd -> ShowS #

show :: ConfigValue cmd -> String #

showList :: [ConfigValue cmd] -> ShowS #

Generic (ConfigValue cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Associated Types

type Rep (ConfigValue cmd) :: * -> * #

Methods

from :: ConfigValue cmd -> Rep (ConfigValue cmd) x #

to :: Rep (ConfigValue cmd) x -> ConfigValue cmd #

FromJSON cmd => FromJSON (ConfigValue cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser (ConfigValue cmd) #

parseJSONList :: Value -> Parser [ConfigValue cmd] #

type Rep (ConfigValue cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

type Rep (ConfigValue cmd) = D1 (MetaData "ConfigValue" "System.Etc.Internal.Spec.Types" "etc-0.4.0.3-1VdOfTC1BjK5K2oA1bREav" False) (C1 (MetaCons "ConfigValue" PrefixI True) ((S1 (MetaSel (Just "defaultValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Value)) :*: S1 (MetaSel (Just "configValueType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ConfigValueType)) :*: (S1 (MetaSel (Just "isSensitive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "configSources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (ConfigSources cmd)))) :+: C1 (MetaCons "SubConfig" PrefixI True) (S1 (MetaSel (Just "subConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (HashMap Text (ConfigValue cmd)))))

data CliProgramSpec #

Constructors

CliProgramSpec 

Fields

Instances
Eq CliProgramSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: CliProgramSpec -> CliProgramSpec -> Bool #

(/=) :: CliProgramSpec -> CliProgramSpec -> Bool #

Show CliProgramSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> CliProgramSpec -> ShowS #

show :: CliProgramSpec -> String #

showList :: [CliProgramSpec] -> ShowS #

FromJSON CliProgramSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser CliProgramSpec #

parseJSONList :: Value -> Parser [CliProgramSpec] #

data FilesSpec #

Constructors

FilePathsSpec ![Text] 
FilesSpec 

Fields

Instances
Eq FilesSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

(==) :: FilesSpec -> FilesSpec -> Bool #

(/=) :: FilesSpec -> FilesSpec -> Bool #

Show FilesSpec # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> FilesSpec -> ShowS #

show :: FilesSpec -> String #

showList :: [FilesSpec] -> ShowS #

data ConfigSpec cmd #

Constructors

ConfigSpec 

Fields

Instances
Eq cmd => Eq (ConfigSpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

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

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

Show cmd => Show (ConfigSpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

showsPrec :: Int -> ConfigSpec cmd -> ShowS #

show :: ConfigSpec cmd -> String #

showList :: [ConfigSpec cmd] -> ShowS #

FromJSON cmd => FromJSON (ConfigSpec cmd) # 
Instance details

Defined in System.Etc.Internal.Spec.Types

Methods

parseJSON :: Value -> Parser (ConfigSpec cmd) #

parseJSONList :: Value -> Parser [ConfigSpec cmd] #

cliArgTypeParser :: Object -> Parser CliArgValueType #

cliArgParser :: Object -> Parser CliEntryMetadata #

cliOptParser :: Object -> Parser CliEntryMetadata #

cliArgKeys :: [Text] #

cliOptKeys :: [Text] #

inferErrorMsg :: String #

parseBytesToConfigValueJSON :: ConfigValueType -> Text -> Maybe Value #

jsonToConfigValueType :: Value -> Either String ConfigValueType #

matchesConfigValueType :: Value -> ConfigValueType -> Bool #

assertMatchingConfigValueType :: Monad m => Value -> ConfigValueType -> m () #

getConfigValueType :: Maybe Value -> Maybe ConfigValueType -> Parser ConfigValueType #

parseFiles :: Value -> Parser FilesSpec #

parseFilePaths :: Value -> Parser FilesSpec #

parseFileSpec :: Value -> Parser (Maybe FilesSpec) #