Safe Haskell | Safe |
---|---|
Language | Haskell2010 |
Synopsis
- data Opt a = Opt {
- _optLong :: Maybe String
- _optShort :: Maybe Char
- _optHelp :: Maybe String
- _optMetavar :: Maybe String
- _optEnvVar :: Maybe String
- _optDefaultVal :: Maybe a
- _optDefaultStr :: Maybe String
- _optReader :: OptReader a
- _optType :: OptType a
- data OptionOpt (attr :: [OptAttr]) a = OptionOpt {}
- data FlagOpt (attr :: [OptAttr]) a = FlagOpt {}
- data ArgumentOpt (attr :: [OptAttr]) a = ArgumentOpt {}
- data OptAttr
- data OptType a
- data SomeOpt where
- type OptReader a = String -> Either String a
- data HargCtx = HargCtx {
- _hcEnv :: Environment
- _hcArgs :: Args
- type Environment = [(String, String)]
- getCtx :: IO HargCtx
- ctxFromArgs :: Args -> IO HargCtx
- ctxFromEnv :: Environment -> IO HargCtx
- pureCtx :: Environment -> Args -> HargCtx
Documentation
The basic option type
Opt | |
|
data OptionOpt (attr :: [OptAttr]) a Source #
Option for flags with arguments. Corresponds to option
.
Instances
IsOpt OptionOpt attr Source # | |
Defined in Options.Harg.Construct | |
HasOptional OptionOpt a Source # | |
Defined in Options.Harg.Construct optional :: (NotInAttrs 'OptOptional a (DuplicateAttrErr "optional"), NotInAttrs 'OptDefault a (IncompatibleAttrsErr "optional" "defaultVal")) => OptionOpt a a0 -> OptionOpt ('OptOptional ': a) (Maybe a0) Source # | |
HasDefaultVal OptionOpt a Source # | |
Defined in Options.Harg.Construct defaultVal :: (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "defaultVal" '["defaultStr", "required"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "defaultVal" "optional")) => a0 -> OptionOpt a a0 -> OptionOpt ('OptDefault ': a) a0 Source # | |
HasRequired OptionOpt a Source # | |
Defined in Options.Harg.Construct required :: forall (a0 :: k). (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "required" '["defaultVal", "defaultStr"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "required" "optional")) => OptionOpt a a0 -> OptionOpt ('OptDefault ': a) a0 Source # | |
HasDefaultStr OptionOpt a Source # | |
Defined in Options.Harg.Construct defaultStr :: forall (a0 :: k). (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "defaultStr" '["defaultVal", "required"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "defaultStr" "optional")) => String -> OptionOpt a a0 -> OptionOpt ('OptDefault ': a) a0 Source # | |
HasEnvVar OptionOpt a Source # | |
HasMetavar OptionOpt a Source # | |
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 | |
HasOptional ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optional :: (NotInAttrs 'OptOptional a (DuplicateAttrErr "optional"), NotInAttrs 'OptDefault a (IncompatibleAttrsErr "optional" "defaultVal")) => ArgumentOpt a a0 -> ArgumentOpt ('OptOptional ': a) (Maybe a0) Source # | |
HasDefaultVal ArgumentOpt a Source # | |
Defined in Options.Harg.Construct defaultVal :: (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "defaultVal" '["defaultStr", "required"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "defaultVal" "optional")) => a0 -> ArgumentOpt a a0 -> ArgumentOpt ('OptDefault ': a) a0 Source # | |
HasRequired ArgumentOpt a Source # | |
Defined in Options.Harg.Construct required :: forall (a0 :: k). (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "required" '["defaultVal", "defaultStr"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "required" "optional")) => ArgumentOpt a a0 -> ArgumentOpt ('OptDefault ': a) a0 Source # | |
HasDefaultStr ArgumentOpt a Source # | |
Defined in Options.Harg.Construct defaultStr :: forall (a0 :: k). (NotInAttrs 'OptDefault a (DuplicateAttrMultipleErr "defaultStr" '["defaultVal", "required"]), NotInAttrs 'OptOptional a (IncompatibleAttrsErr "defaultStr" "optional")) => String -> ArgumentOpt a a0 -> ArgumentOpt ('OptDefault ': a) a0 Source # | |
HasEnvVar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct envVar :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasMetavar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct metavar :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasHelp ArgumentOpt a Source # | |
Defined in Options.Harg.Construct help :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # |
Option types
OptionOptType | |
FlagOptType a |
|
ArgumentOptType |
Existential wrapper for Opt
, so that many options can be carried in
a list.
Context to carry around, that contains environment variables and command line arguments.
HargCtx | |
|
type Environment = [(String, String)] Source #
Environment variable pairs, can be retrieved with getEnvironment
.
ctxFromArgs :: Args -> IO HargCtx Source #
ctxFromEnv :: Environment -> IO HargCtx Source #
pureCtx :: Environment -> Args -> HargCtx Source #