Moduleoptparse-applicative-0.19.0.0

Options.Applicative.Types

27 types
17 values

Packageoptparse-applicative-0.19.0.0
Exports44
LicenceBSD-3-Clause

valuefilterOptional :: OptTree a -> OptTree a

valuefromM :: ParserM a -> Parser a

valueisLongName :: OptName -> Bool

valueisShortName :: OptName -> Bool

valuemanyM :: Parser a -> ParserM [a]

valuemkCompleter :: (String -> IO [String]) -> Completer

valueoneM :: Parser a -> ParserM a

valueoptDescMod :: Option a -> Maybe (Doc -> Doc)

valueoptHelp :: Option a -> Chunk Doc

valueoptMetaVar :: Option a -> String

valueoptShowDefault :: Option a -> Maybe String

valueoptVisibility :: Option a -> OptVisibility

valueoverFailure

valuereaderAbort :: ParseError -> ReadM a

valuereaderAsk :: ReadM String

valuereaderError :: String -> ReadM a

valuesomeM :: Parser a -> ParserM [a]

datadata ParserHelp

Constructors

ParserHelp
- helpError :: Chunk Doc
- helpSuggestions :: Chunk Doc
- helpHeader :: Chunk Doc
- helpUsage :: Chunk Doc
- helpDescription :: Chunk Doc
- helpBody :: Chunk Doc
- helpGlobals :: Chunk Doc
- helpFooter :: Chunk Doc

Instances3Show, Semigroup, Monoid

Show ParserHelpDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Help.Types
Semigroup ParserHelpDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Help.Types
Monoid ParserHelpDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Help.Types

datadata AltNodeType

MarkDefault NoDefault

Instances2Eq, Show

Eq AltNodeTypeDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show AltNodeTypeDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata ArgPolicy

Intersperse NoIntersperse AllPositionals ForwardOptions

Instances3Eq, Ord, Show

Eq ArgPolicyDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Ord ArgPolicyDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show ArgPolicyDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

typetype Args = [String]

newtypenewtype ArgumentReachability

Constructors

ArgumentReachability
- argumentIsUnreachable :: Bool

Instances2Eq, Show

Eq ArgumentReachabilityDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show ArgumentReachabilityDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata Backtracking

Backtrack NoBacktrack SubparserInline

Instances2Eq, Show

Eq BacktrackingDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show BacktrackingDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata CReader a

Constructors

CReader
- crCompleter :: Completer
- crReader :: ReadM a

Instances1Functor

Functor CReaderDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype Completer

Constructors

Completer
- runCompleter :: String -> IO [String]

Instances2Semigroup, Monoid

Semigroup CompleterDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Monoid CompleterDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype CompletionResult

Constructors

CompletionResult
- execCompletion :: String -> IO String

Instances1Show

Show CompletionResultDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata Context

Constructors

forall a. Context String (ParserInfo a)

datadata IsCmdStart

CmdStart CmdCont

Instances1Show

Show IsCmdStartDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype OptGroup

Constructors

OptGroup [String]

Instances3Eq, Ord, Show

Eq OptGroupDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Ord OptGroupDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show OptGroupDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata OptName

Constructors

OptShort !Char
OptLong !String

Instances3Eq, Ord, Show

Eq OptNameDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Ord OptNameDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show OptNameDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata OptProperties

Constructors

OptProperties
- propVisibility :: OptVisibility
- propHelp :: Chunk Doc
- propMetaVar :: String
- propShowDefault :: Maybe String
- propShowGlobal :: Bool
- propDescMod :: Maybe (Doc -> Doc)
- propGroup :: OptGroup

Instances1Show

Show OptPropertiesDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata OptReader a

Constructors

OptReader [OptName] (CReader a) (String -> ParseError)
FlagReader [OptName] !a
ArgReader (CReader a)
CmdReader (Maybe String) [(String, ParserInfo a)]

Instances1Functor

Functor OptReaderDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata OptTree a

Constructors

Leaf a
MultNode [OptTree a]
AltNode AltNodeType [OptTree a]
BindNode (OptTree a)

Instances1Show

Show a => Show (OptTree a)Defined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata OptVisibility

Internal Hidden Visible

Instances3Eq, Ord, Show

Eq OptVisibilityDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Ord OptVisibilityDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show OptVisibilityDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata Option a

Constructors

Option
- optMain :: OptReader a
- optProps :: OptProperties

Instances2Functor, Show

Functor OptionDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show (Option a)Defined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata ParseError

Constructors

ErrorMsg String
InfoMsg String
ShowHelpText (Maybe String)
UnknownError
MissingError IsCmdStart SomeParser
ExpectsArgError String
UnexpectedError String SomeParser

Instances2Semigroup, Monoid

Semigroup ParseErrorDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Monoid ParseErrorDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata Parser a

Constructors

NilP (Maybe a)
OptP (Option a)
forall x. MultP (Parser (x -> a)) (Parser x)
AltP (Parser a) (Parser a)
forall x. BindP (Parser x) (x -> Parser a)

Instances3Functor, Applicative, Alternative

Functor ParserDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Applicative ParserDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Alternative ParserDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype ParserFailure h

Constructors

ParserFailure
- execFailure :: String -> (h, ExitCode, Int)

Instances2Functor, Show

Functor ParserFailureDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show h => Show (ParserFailure h)Defined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata ParserInfo a

Constructors

ParserInfo
- infoParser :: Parser a
- infoFullDesc :: Bool
- infoProgDesc :: Chunk Doc
- infoHeader :: Chunk Doc
- infoFooter :: Chunk Doc
- infoFailureCode :: Int
- infoPolicy :: ArgPolicy

Instances1Functor

Functor ParserInfoDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype ParserM r

Constructors

ParserM
- runParserM :: forall x. (r -> Parser x) -> Parser x

Instances3Monad, Functor, Applicative

Monad ParserMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Functor ParserMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Applicative ParserMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata ParserPrefs

Constructors

ParserPrefs
- prefMultiSuffix :: String
- prefDisambiguate :: Bool
- prefShowHelpOnError :: Bool
- prefShowHelpOnEmpty :: Bool
- prefBacktrack :: Backtracking
- prefColumns :: Int
- prefHelpLongEquals :: Bool
- prefHelpShowGlobal :: Bool
- prefTabulateFill :: Int
- prefBriefHangPoint :: Int

Instances2Eq, Show

Eq ParserPrefsDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show ParserPrefsDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata ParserResult a

Constructors

Success a
Failure (ParserFailure ParserHelp)
CompletionInvoked CompletionResult

Instances4Monad, Functor, Applicative, Show

Monad ParserResultDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Functor ParserResultDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Applicative ParserResultDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Show a => Show (ParserResult a)Defined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

newtypenewtype ReadM a

Constructors

ReadM
- unReadM :: ReaderT String (Except ParseError) a

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Functor ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
MonadFail ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Applicative ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
Alternative ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types
MonadPlus ReadMDefined in optparse-applicative-0.19.0.0 · Options.Applicative.Types

datadata SomeParser

Constructors

forall a. SomeParser (Parser a)