Safe Haskell | Safe |
---|---|
Language | Haskell2010 |
Synopsis
- type OptReader a = String -> Either String a
- data Opt a = Opt {}
- data OptType a
- data OptAttr
- data OptionOpt (attr :: [OptAttr]) a = OptionOpt {}
- data FlagOpt (attr :: [OptAttr]) a = FlagOpt {}
- data ArgumentOpt (attr :: [OptAttr]) a = ArgumentOpt {}
- data OptError = OptError {}
- data SomeOpt where
- type Environment = [(String, String)]
- type Args = [String]
- data HargCtx = HargCtx {
- _hcEnv :: Environment
- _hcArgs :: Args
- getCtx :: IO HargCtx
- ctxFromArgs :: Args -> IO HargCtx
- ctxFromEnv :: Environment -> IO HargCtx
- pureCtx :: Environment -> Args -> HargCtx
- toOptError :: Opt a -> Maybe String -> String -> OptError
Documentation
The basic option type
Opt | |
|
Option types
OptionOptType | |
FlagOptType a |
|
ArgumentOptType |
Intermediate option types
data OptionOpt (attr :: [OptAttr]) a Source #
Option for flags with arguments. Corresponds to option
.
Instances
IsOpt OptionOpt attr Source # | |
HasOptional OptionOpt a Source # | |
Defined in Options.Harg.Construct optOptional :: NotInAttrs OptDefault a "optOptional" "optDefault" => OptionOpt a a0 -> OptionOpt (OptOptional ': a) (Maybe a0) Source # | |
HasDefault OptionOpt a Source # | |
Defined in Options.Harg.Construct optDefault :: NotInAttrs OptOptional a "optDefault" "optOptional" => a0 -> OptionOpt a a0 -> OptionOpt (OptDefault ': a) a0 Source # | |
HasEnvVar OptionOpt a Source # | |
HasMetavar OptionOpt a Source # | |
Defined in Options.Harg.Construct | |
HasHelp OptionOpt a Source # | |
HasShort OptionOpt a Source # | |
HasLong OptionOpt a Source # | |
data FlagOpt (attr :: [OptAttr]) a Source #
Option for flags that act like switches between a default and an active
value. Corresponds to flag
.
data ArgumentOpt (attr :: [OptAttr]) a Source #
Option for arguments (no long/short specifiers). Corresponds to
argument
.
Instances
IsOpt ArgumentOpt attr Source # | |
Defined in Options.Harg.Construct toOpt :: ArgumentOpt attr a -> Opt a Source # | |
HasOptional ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optOptional :: NotInAttrs OptDefault a "optOptional" "optDefault" => ArgumentOpt a a0 -> ArgumentOpt (OptOptional ': a) (Maybe a0) Source # | |
HasDefault ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optDefault :: NotInAttrs OptOptional a "optDefault" "optOptional" => a0 -> ArgumentOpt a a0 -> ArgumentOpt (OptDefault ': a) a0 Source # | |
HasEnvVar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optEnvVar :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasMetavar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optMetavar :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasHelp ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optHelp :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # |
Datatype that holds errors that arise when running the sources.
The reason why this is the only place where errors occur is that,
if something goes wrong when running the parser, it will be handled
by optparse-applicative
.
Existential wrapper for Opt
, so that many options can be carried in
a list.
type Environment = [(String, String)] Source #
Environment variable pairs, can be retrieved with getEnvironment
.
Context to carry around, that contains environment variables and command line arguments.
HargCtx | |
|
ctxFromEnv :: Environment -> IO HargCtx Source #