Safe Haskell	None
Language	Haskell2010

System.Etc.Internal.Spec.Types

Documentation

data ConfigurationError Source #

Constructors

InvalidConfiguration Text
InvalidConfigKeyPath [Text]
ConfigurationFileNotFound Text

Instances

Show ConfigurationError Source #
Methods showsPrec :: Int -> ConfigurationError -> ShowS # show :: ConfigurationError -> String # showList :: [ConfigurationError] -> ShowS #
Exception ConfigurationError Source #
Methods toException :: ConfigurationError -> SomeException # fromException :: SomeException -> Maybe ConfigurationError # displayException :: ConfigurationError -> String #

data CliOptValueType Source #

Constructors

StringOpt
NumberOpt
SwitchOpt

Instances

Eq CliOptValueType Source #
Methods (==) :: CliOptValueType -> CliOptValueType -> Bool # (/=) :: CliOptValueType -> CliOptValueType -> Bool #
Show CliOptValueType Source #
Methods showsPrec :: Int -> CliOptValueType -> ShowS # show :: CliOptValueType -> String # showList :: [CliOptValueType] -> ShowS #

data CliArgValueType Source #

Constructors

StringArg
NumberArg

Instances

Eq CliArgValueType Source #
Methods (==) :: CliArgValueType -> CliArgValueType -> Bool # (/=) :: CliArgValueType -> CliArgValueType -> Bool #
Show CliArgValueType Source #
Methods showsPrec :: Int -> CliArgValueType -> ShowS # show :: CliArgValueType -> String # showList :: [CliArgValueType] -> ShowS #

data CliEntryMetadata Source #

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

data CliEntrySpec cmd Source #

Constructors

CmdEntry
Fields cliEntryCmdValue :: Vector cmd cliEntryMetadata :: CliEntryMetadata
PlainEntry
Fields cliEntryMetadata :: CliEntryMetadata

Instances

Eq cmd => Eq (CliEntrySpec cmd) Source #
Methods (==) :: CliEntrySpec cmd -> CliEntrySpec cmd -> Bool # (/=) :: CliEntrySpec cmd -> CliEntrySpec cmd -> Bool #
Show cmd => Show (CliEntrySpec cmd) Source #
Methods showsPrec :: Int -> CliEntrySpec cmd -> ShowS # show :: CliEntrySpec cmd -> String # showList :: [CliEntrySpec cmd] -> ShowS #
FromJSON cmd => FromJSON (CliEntrySpec cmd) Source #
Methods parseJSON :: Value -> Parser (CliEntrySpec cmd) # parseJSONList :: Value -> Parser [CliEntrySpec cmd] #

data CliCmdSpec Source #

Constructors

CliCmdSpec
Fields cliCmdDesc :: Text cliCmdHeader :: Text

Instances

Eq CliCmdSpec Source #
Methods (==) :: CliCmdSpec -> CliCmdSpec -> Bool # (/=) :: CliCmdSpec -> CliCmdSpec -> Bool #
Show CliCmdSpec Source #
Methods showsPrec :: Int -> CliCmdSpec -> ShowS # show :: CliCmdSpec -> String # showList :: [CliCmdSpec] -> ShowS #
FromJSON CliCmdSpec Source #
Methods parseJSON :: Value -> Parser CliCmdSpec # parseJSONList :: Value -> Parser [CliCmdSpec] #

data ConfigSources cmd Source #

Constructors

ConfigSources
Fields envVar :: Maybe Text cliEntry :: Maybe (CliEntrySpec cmd)

Instances

Eq cmd => Eq (ConfigSources cmd) Source #
Methods (==) :: ConfigSources cmd -> ConfigSources cmd -> Bool # (/=) :: ConfigSources cmd -> ConfigSources cmd -> Bool #
Show cmd => Show (ConfigSources cmd) Source #
Methods showsPrec :: Int -> ConfigSources cmd -> ShowS # show :: ConfigSources cmd -> String # showList :: [ConfigSources cmd] -> ShowS #

data ConfigValue cmd Source #

Constructors

ConfigValue
Fields defaultValue :: Maybe Value configSources :: ConfigSources cmd
SubConfig
Fields subConfig :: HashMap Text (ConfigValue cmd)

Instances

Eq cmd => Eq (ConfigValue cmd) Source #
Methods (==) :: ConfigValue cmd -> ConfigValue cmd -> Bool # (/=) :: ConfigValue cmd -> ConfigValue cmd -> Bool #
Show cmd => Show (ConfigValue cmd) Source #
Methods showsPrec :: Int -> ConfigValue cmd -> ShowS # show :: ConfigValue cmd -> String # showList :: [ConfigValue cmd] -> ShowS #
FromJSON cmd => FromJSON (ConfigValue cmd) Source #
Methods parseJSON :: Value -> Parser (ConfigValue cmd) # parseJSONList :: Value -> Parser [ConfigValue cmd] #

data CliProgramSpec Source #

Constructors

CliProgramSpec
Fields cliProgramDesc :: Text cliProgramHeader :: Text cliCommands :: Maybe (HashMap Text CliCmdSpec)

Instances

Eq CliProgramSpec Source #
Methods (==) :: CliProgramSpec -> CliProgramSpec -> Bool # (/=) :: CliProgramSpec -> CliProgramSpec -> Bool #
Show CliProgramSpec Source #
Methods showsPrec :: Int -> CliProgramSpec -> ShowS # show :: CliProgramSpec -> String # showList :: [CliProgramSpec] -> ShowS #
FromJSON CliProgramSpec Source #
Methods parseJSON :: Value -> Parser CliProgramSpec # parseJSONList :: Value -> Parser [CliProgramSpec] #

data ConfigSpec cmd Source #

Constructors

ConfigSpec
Fields specConfigFilepaths :: [Text] specCliProgramSpec :: Maybe CliProgramSpec specConfigValues :: HashMap Text (ConfigValue cmd)

Instances

Eq cmd => Eq (ConfigSpec cmd) Source #
Methods (==) :: ConfigSpec cmd -> ConfigSpec cmd -> Bool # (/=) :: ConfigSpec cmd -> ConfigSpec cmd -> Bool #
Show cmd => Show (ConfigSpec cmd) Source #
Methods showsPrec :: Int -> ConfigSpec cmd -> ShowS # show :: ConfigSpec cmd -> String # showList :: [ConfigSpec cmd] -> ShowS #
FromJSON cmd => FromJSON (ConfigSpec cmd) Source #
Methods parseJSON :: Value -> Parser (ConfigSpec cmd) # parseJSONList :: Value -> Parser [ConfigSpec cmd] #

cliArgTypeParser :: Object -> Parser CliArgValueType Source #

cliArgParser :: Object -> Parser CliEntryMetadata Source #

cliOptTypeParser :: Object -> Parser CliOptValueType Source #

cliOptParser :: Object -> Parser CliEntryMetadata Source #

cliArgKeys :: [Text] Source #

cliOptKeys :: [Text] Source #