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

Exception ConfigurationError

Methods

toException :: ConfigurationError -> SomeException

fromException :: SomeException -> Maybe ConfigurationError

displayException :: ConfigurationError -> String

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

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

data CliEntryMetadata

Constructors

Opt

Fields

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

Arg

Fields

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

Instances

Eq CliEntryMetadata

Methods

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

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

Show CliEntryMetadata

Methods

showsPrec :: Int -> CliEntryMetadata -> ShowS

show :: CliEntryMetadata -> String

showList :: [CliEntryMetadata] -> ShowS

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

FromJSON cmd => FromJSON (CliEntrySpec cmd)

Methods

parseJSON :: Value -> Parser (CliEntrySpec cmd)

parseJSONList :: Value -> Parser [CliEntrySpec cmd]

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

FromJSON CliCmdSpec

Methods

parseJSON :: Value -> Parser CliCmdSpec

parseJSONList :: Value -> Parser [CliCmdSpec]

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

data ConfigValue cmd

Constructors

ConfigValue

Fields

• defaultValue :: !(Maybe Value)
• 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

FromJSON cmd => FromJSON (ConfigValue cmd)

Methods

parseJSON :: Value -> Parser (ConfigValue cmd)

parseJSONList :: Value -> Parser [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

cliOptTypeParser :: Object -> Parser CliOptValueType

cliOptParser :: Object -> Parser CliEntryMetadata

cliArgKeys :: [Text]

cliOptKeys :: [Text]

parseFiles :: Value -> Parser FilesSpec

parseFilePaths :: Value -> Parser FilesSpec

parseFileSpec :: Value -> Parser (Maybe FilesSpec)