Options.Applicative.Types

Documentation

data ParserInfo a

A full description for a runnable Parser for a program.

Constructors

ParserInfo

Fields

_infoParser :: Parser a

the option parser for the program

_infoFullDesc :: Bool

whether the help text should contain full documentation

_infoProgDesc :: String

brief parser description

_infoHeader :: String

header of the full parser description

_infoFooter :: String

footer of the full parser description

_infoFailureCode :: Int

exit code for a parser failure

Instances

Functor ParserInfo

infoParser :: forall a. Lens (ParserInfo a) (Parser a)

infoFullDesc :: forall a. Lens (ParserInfo a) Bool

infoProgDesc :: forall a. Lens (ParserInfo a) String

infoHeader :: forall a. Lens (ParserInfo a) String

infoFooter :: forall a. Lens (ParserInfo a) String

infoFailureCode :: forall a. Lens (ParserInfo a) Int

data Option r a

Specification for an individual parser option.

Constructors

Option

option continuation

Fields

_optMain :: OptReader r

reader for this option

_optDefault :: Maybe a

default value

_optShow :: Bool

whether this flag is shown is the brief description

_optHelp :: String

help text for this option

_optMetaVar :: String

metavariable for this option

_optCont :: r -> Maybe (Parser a)

Instances

Functor (Option r)

data OptName

Constructors

OptShort !Char

OptLong !String

Instances

Eq OptName

Ord OptName

data OptReader a

An OptReader defines whether an option matches an command line argument.

Constructors

OptReader [OptName] (String -> Maybe a)

option reader

FlagReader [OptName] !a

flag reader

ArgReader (String -> Maybe a)

argument reader

CmdReader [String] (String -> Maybe (ParserInfo a))

command reader

Instances

Functor OptReader

data Parser a where

A Parser a is an option parser returning a value of type a.

Constructors

NilP :: a -> Parser a

ConsP :: Option r (a -> b) -> Parser a -> Parser b

Instances

Functor Parser

Applicative Parser

data P a

Constructors

ParseError

ParseResult a

Instances

Monad P

Functor P

Applicative P

optMain :: forall r a. Lens (Option r a) (OptReader r)

optDefault :: forall r a. Lens (Option r a) (Maybe a)

optShow :: forall r a. Lens (Option r a) Bool

optHelp :: forall r a. Lens (Option r a) String

optMetaVar :: forall r a. Lens (Option r a) String

optCont :: forall r a. Lens (Option r a) (r -> Maybe (Parser a))