System.Etc.Internal.Spec.Types

Documentation

data ConfigurationError

Constructors

InvalidConfiguration !(Maybe Text) !Text

InvalidConfigKeyPath ![Text]

ConfigurationFileNotFound !Text

Instances

Show ConfigurationError

Methods

showsPrec :: Int -> ConfigurationError -> ShowS

show :: ConfigurationError -> String

showList :: [ConfigurationError] -> ShowS

Generic ConfigurationError

Associated Types

type Rep ConfigurationError :: * -> *

Methods

from :: ConfigurationError -> Rep ConfigurationError x

to :: Rep ConfigurationError x -> ConfigurationError

Exception ConfigurationError

Methods

toException :: ConfigurationError -> SomeException

fromException :: SomeException -> Maybe ConfigurationError

displayException :: ConfigurationError -> String

type Rep ConfigurationError

type Rep ConfigurationError = D1 * (MetaData "ConfigurationError" "System.Etc.Internal.Spec.Types" "etc-0.4.0.1-4dAjba5FFiAF6sIx6yxiVq" False) ((:+:) * (C1 * (MetaCons "InvalidConfiguration" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:+:) * (C1 * (MetaCons "InvalidConfigKeyPath" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text]))) (C1 * (MetaCons "ConfigurationFileNotFound" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

data CliOptValueType

Constructors

StringOpt

NumberOpt

SwitchOpt

Instances

Eq CliOptValueType

Methods

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

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

Show CliOptValueType

Methods

showsPrec :: Int -> CliOptValueType -> ShowS

show :: CliOptValueType -> String

showList :: [CliOptValueType] -> ShowS

Generic CliOptValueType

Associated Types

type Rep CliOptValueType :: * -> *

Methods

from :: CliOptValueType -> Rep CliOptValueType x

to :: Rep CliOptValueType x -> CliOptValueType

type Rep CliOptValueType

type Rep CliOptValueType = D1 * (MetaData "CliOptValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.1-4dAjba5FFiAF6sIx6yxiVq" 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

Methods

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

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

Show CliArgValueType

Methods

showsPrec :: Int -> CliArgValueType -> ShowS

show :: CliArgValueType -> String

showList :: [CliArgValueType] -> ShowS

Generic CliArgValueType

Associated Types

type Rep CliArgValueType :: * -> *

Methods

from :: CliArgValueType -> Rep CliArgValueType x

to :: Rep CliArgValueType x -> CliArgValueType

type Rep CliArgValueType

type Rep CliArgValueType = D1 * (MetaData "CliArgValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.1-4dAjba5FFiAF6sIx6yxiVq" False) ((:+:) * (C1 * (MetaCons "StringArg" PrefixI False) (U1 *)) (C1 * (MetaCons "NumberArg" PrefixI False) (U1 *)))

data CliEntryMetadata

Constructors

Opt

Fields

• optLong :: !(Maybe Text)
• optShort :: !(Maybe Text)
• optMetavar :: !(Maybe Text)
• optHelp :: !(Maybe Text)
• optRequired :: !Bool

Arg

Fields

• argMetavar :: !(Maybe Text)
• optRequired :: !Bool

Instances

Eq CliEntryMetadata

Methods

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

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

Show CliEntryMetadata

Methods

showsPrec :: Int -> CliEntryMetadata -> ShowS

show :: CliEntryMetadata -> String

showList :: [CliEntryMetadata] -> ShowS

Generic CliEntryMetadata

Associated Types

type Rep CliEntryMetadata :: * -> *

Methods

from :: CliEntryMetadata -> Rep CliEntryMetadata x

to :: Rep CliEntryMetadata x -> CliEntryMetadata

type Rep CliEntryMetadata

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

data CliEntrySpec cmd

Constructors

CmdEntry

Fields

• cliEntryCmdValue :: !(Vector cmd)
• cliEntryMetadata :: !CliEntryMetadata

PlainEntry

Fields

• cliEntryMetadata :: !CliEntryMetadata

Instances

Eq cmd => Eq (CliEntrySpec cmd)

Methods

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

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

Show cmd => Show (CliEntrySpec cmd)

Methods

showsPrec :: Int -> CliEntrySpec cmd -> ShowS

show :: CliEntrySpec cmd -> String

showList :: [CliEntrySpec cmd] -> ShowS

Generic (CliEntrySpec cmd)

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)

Methods

parseJSON :: Value -> Parser (CliEntrySpec cmd)

parseJSONList :: Value -> Parser [CliEntrySpec cmd]

type Rep (CliEntrySpec cmd)

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

data CliCmdSpec

Constructors

CliCmdSpec

Fields

• cliCmdDesc :: !Text
• cliCmdHeader :: !Text

Instances

Eq CliCmdSpec

Methods

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

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

Show CliCmdSpec

Methods

showsPrec :: Int -> CliCmdSpec -> ShowS

show :: CliCmdSpec -> String

showList :: [CliCmdSpec] -> ShowS

Generic CliCmdSpec

Associated Types

type Rep CliCmdSpec :: * -> *

Methods

from :: CliCmdSpec -> Rep CliCmdSpec x

to :: Rep CliCmdSpec x -> CliCmdSpec

FromJSON CliCmdSpec

Methods

parseJSON :: Value -> Parser CliCmdSpec

parseJSONList :: Value -> Parser [CliCmdSpec]

type Rep CliCmdSpec

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

data ConfigSources cmd

Constructors

ConfigSources

Fields

• envVar :: !(Maybe Text)
• cliEntry :: !(Maybe (CliEntrySpec cmd))

Instances

Eq cmd => Eq (ConfigSources cmd)

Methods

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

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

Show cmd => Show (ConfigSources cmd)

Methods

showsPrec :: Int -> ConfigSources cmd -> ShowS

show :: ConfigSources cmd -> String

showList :: [ConfigSources cmd] -> ShowS

Generic (ConfigSources cmd)

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)

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

data SingleConfigValueType

Constructors

CVTString

CVTNumber

CVTBool

CVTObject

Instances

Eq SingleConfigValueType

Methods

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

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

Show SingleConfigValueType

Methods

showsPrec :: Int -> SingleConfigValueType -> ShowS

show :: SingleConfigValueType -> String

showList :: [SingleConfigValueType] -> ShowS

Generic SingleConfigValueType

Associated Types

type Rep SingleConfigValueType :: * -> *

Methods

from :: SingleConfigValueType -> Rep SingleConfigValueType x

to :: Rep SingleConfigValueType x -> SingleConfigValueType

Display SingleConfigValueType

Methods

display :: SingleConfigValueType -> Utf8Builder

type Rep SingleConfigValueType

type Rep SingleConfigValueType = D1 * (MetaData "SingleConfigValueType" "System.Etc.Internal.Spec.Types" "etc-0.4.0.1-4dAjba5FFiAF6sIx6yxiVq" 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

Methods

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

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

Show ConfigValueType

Methods

showsPrec :: Int -> ConfigValueType -> ShowS

show :: ConfigValueType -> String

showList :: [ConfigValueType] -> ShowS

Generic ConfigValueType

Associated Types

type Rep ConfigValueType :: * -> *

Methods

from :: ConfigValueType -> Rep ConfigValueType x

to :: Rep ConfigValueType x -> ConfigValueType

FromJSON ConfigValueType

Methods

parseJSON :: Value -> Parser ConfigValueType

parseJSONList :: Value -> Parser [ConfigValueType]

Display ConfigValueType

Methods

display :: ConfigValueType -> Utf8Builder

type Rep ConfigValueType

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

data ConfigValue cmd

Constructors

ConfigValue

Fields

• defaultValue :: !(Maybe Value)
• configValueType :: !ConfigValueType
• isSensitive :: !Bool
• configSources :: !(ConfigSources cmd)

SubConfig

Fields

• subConfig :: !(HashMap Text (ConfigValue cmd))

Instances

Eq cmd => Eq (ConfigValue cmd)

Methods

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

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

Show cmd => Show (ConfigValue cmd)

Methods

showsPrec :: Int -> ConfigValue cmd -> ShowS

show :: ConfigValue cmd -> String

showList :: [ConfigValue cmd] -> ShowS

Generic (ConfigValue cmd)

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)

Methods

parseJSON :: Value -> Parser (ConfigValue cmd)

parseJSONList :: Value -> Parser [ConfigValue cmd]

type Rep (ConfigValue cmd)

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

data CliProgramSpec

Constructors

CliProgramSpec

Fields

• cliProgramDesc :: !Text
• cliProgramHeader :: !Text
• cliCommands :: !(Maybe (HashMap Text CliCmdSpec))

Instances

Eq CliProgramSpec

Methods

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

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

Show CliProgramSpec

Methods

showsPrec :: Int -> CliProgramSpec -> ShowS

show :: CliProgramSpec -> String

showList :: [CliProgramSpec] -> ShowS

FromJSON CliProgramSpec

Methods

parseJSON :: Value -> Parser CliProgramSpec

parseJSONList :: Value -> Parser [CliProgramSpec]

data FilesSpec

Constructors

FilePathsSpec ![Text]

FilesSpec

Fields

• fileLocationEnvVar :: !(Maybe Text)
• fileLocationPaths :: ![Text]

Instances

Eq FilesSpec

Methods

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

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

Show FilesSpec

Methods

showsPrec :: Int -> FilesSpec -> ShowS

show :: FilesSpec -> String

showList :: [FilesSpec] -> ShowS

data ConfigSpec cmd

Constructors

ConfigSpec

Fields

• specConfigFilepaths :: !(Maybe FilesSpec)
• specCliProgramSpec :: !(Maybe CliProgramSpec)
• specConfigValues :: !(HashMap Text (ConfigValue 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]

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)