Safe Haskell	Safe
Language	Haskell2010

Options.Harg.Types

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 {
- _oLong :: Maybe String
- _oShort :: Maybe Char
- _oHelp :: Maybe String
- _oMetavar :: Maybe String
- _oEnvVar :: Maybe String
- _oDefaultVal :: Maybe a
- _oDefaultStr :: Maybe String
- _oReader :: OptReader a
}
data FlagOpt (attr :: [OptAttr]) a = FlagOpt {
- _fLong :: Maybe String
- _fShort :: Maybe Char
- _fHelp :: Maybe String
- _fEnvVar :: Maybe String
- _fDefaultVal :: a
- _fReader :: OptReader a
- _fActive :: a
}
data ArgumentOpt (attr :: [OptAttr]) a = ArgumentOpt {
- _aHelp :: Maybe String
- _aMetavar :: Maybe String
- _aEnvVar :: Maybe String
- _aDefaultVal :: Maybe a
- _aDefaultStr :: Maybe String
- _aReader :: OptReader a
}
data OptAttr
- = OptDefault
- | OptOptional
data OptType a
- = OptionOptType
- | FlagOptType a
- | ArgumentOptType
data SomeOpt where
- SomeOpt :: Opt a -> SomeOpt
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

data Opt a Source #

The basic option type

Constructors

Opt

Fields

_optLong :: Maybe String
Modifier for long options (e.g. --user)
_optShort :: Maybe Char
Modifier for short options (e.g. -u)
_optHelp :: Maybe String
Option help to be shown when invoked with --help/-h or in case of error
_optMetavar :: Maybe String
Metavar to be shown in the help description
_optEnvVar :: Maybe String
Environment variable for use with EnvSource
_optDefaultVal :: Maybe a
Default value
_optDefaultStr :: Maybe String
Default value as string (unparsed)
_optReader :: OptReader a
Option parser
_optType :: OptType a
Option type

Instances

Instances details

Functor Opt Source #
Instance details Defined in Options.Harg.Types Methods fmap :: (a -> b) -> Opt a -> Opt b # (<$) :: a -> Opt b -> Opt a #

data OptionOpt (attr :: [OptAttr]) a Source #

Option for flags with arguments. Corresponds to option.

Constructors

OptionOpt
Fields _oLong :: Maybe String _oShort :: Maybe Char _oHelp :: Maybe String _oMetavar :: Maybe String _oEnvVar :: Maybe String _oDefaultVal :: Maybe a _oDefaultStr :: Maybe String _oReader :: OptReader a

Instances

Instances details

IsOpt OptionOpt attr Source #
Instance details Defined in Options.Harg.Construct Methods toOpt :: OptionOpt attr a -> Opt a
HasOptional OptionOpt a Source #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods envVar :: forall (a0 :: k). String -> OptionOpt a a0 -> OptionOpt a a0 Source #
HasMetavar OptionOpt a Source #
Instance details Defined in Options.Harg.Construct Methods metavar :: forall (a0 :: k). String -> OptionOpt a a0 -> OptionOpt a a0 Source #
HasHelp OptionOpt a Source #
Instance details Defined in Options.Harg.Construct Methods help :: forall (a0 :: k). String -> OptionOpt a a0 -> OptionOpt a a0 Source #
HasShort OptionOpt a Source #
Instance details Defined in Options.Harg.Construct Methods short :: forall (a0 :: k). Char -> OptionOpt a a0 -> OptionOpt a a0 Source #
HasLong OptionOpt a Source #
Instance details Defined in Options.Harg.Construct Methods long :: forall (a0 :: k). String -> OptionOpt a a0 -> OptionOpt a a0 Source #

data FlagOpt (attr :: [OptAttr]) a Source #

Option for flags that act like switches between a default and an active value. Corresponds to flag.

Constructors

FlagOpt
Fields _fLong :: Maybe String _fShort :: Maybe Char _fHelp :: Maybe String _fEnvVar :: Maybe String _fDefaultVal :: a _fReader :: OptReader a _fActive :: a

Instances

Instances details

IsOpt FlagOpt attr Source #
Instance details Defined in Options.Harg.Construct Methods toOpt :: FlagOpt attr a -> Opt a
HasEnvVar FlagOpt a Source #
Instance details Defined in Options.Harg.Construct Methods envVar :: forall (a0 :: k). String -> FlagOpt a a0 -> FlagOpt a a0 Source #
HasHelp FlagOpt a Source #
Instance details Defined in Options.Harg.Construct Methods help :: forall (a0 :: k). String -> FlagOpt a a0 -> FlagOpt a a0 Source #
HasShort FlagOpt a Source #
Instance details Defined in Options.Harg.Construct Methods short :: forall (a0 :: k). Char -> FlagOpt a a0 -> FlagOpt a a0 Source #
HasLong FlagOpt a Source #
Instance details Defined in Options.Harg.Construct Methods long :: forall (a0 :: k). String -> FlagOpt a a0 -> FlagOpt a a0 Source #

data ArgumentOpt (attr :: [OptAttr]) a Source #

Option for arguments (no long/short specifiers). Corresponds to argument.

Constructors

ArgumentOpt
Fields _aHelp :: Maybe String _aMetavar :: Maybe String _aEnvVar :: Maybe String _aDefaultVal :: Maybe a _aDefaultStr :: Maybe String _aReader :: OptReader a

Instances

Instances details

IsOpt ArgumentOpt attr Source #
Instance details Defined in Options.Harg.Construct Methods toOpt :: ArgumentOpt attr a -> Opt a
HasOptional ArgumentOpt a Source #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods 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 #
Instance details Defined in Options.Harg.Construct Methods envVar :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source #
HasMetavar ArgumentOpt a Source #
Instance details Defined in Options.Harg.Construct Methods metavar :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source #
HasHelp ArgumentOpt a Source #
Instance details Defined in Options.Harg.Construct Methods help :: forall (a0 :: k). String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source #

data OptAttr Source #

Constructors

OptDefault
OptOptional

data OptType a Source #

Option types

Constructors

OptionOptType
FlagOptType a	`a` is the active value for the flag parser
ArgumentOptType

Instances

Instances details

Functor OptType Source #
Instance details Defined in Options.Harg.Types Methods fmap :: (a -> b) -> OptType a -> OptType b # (<$) :: a -> OptType b -> OptType a #

data SomeOpt where Source #

Existential wrapper for Opt, so that many options can be carried in a list.

Constructors

SomeOpt :: Opt a -> SomeOpt

type OptReader a = String -> Either String a Source #

data HargCtx Source #

Context to carry around, that contains environment variables and command line arguments.

Constructors

HargCtx
Fields _hcEnv :: Environment _hcArgs :: Args

type Environment = [(String, String)] Source #

Environment variable pairs, can be retrieved with getEnvironment.

getCtx :: IO HargCtx Source #

ctxFromArgs :: Args -> IO HargCtx Source #

ctxFromEnv :: Environment -> IO HargCtx Source #

pureCtx :: Environment -> Args -> HargCtx Source #