Moduleoptions-1.2.1.2

Options

Synopsis

value defaultOptions
value defineOption
value group
value optionType
value optionType_bool
value optionType_double
value optionType_enum
value optionType_float
value optionType_int
value optionType_int16
value optionType_int32
value optionType_int64
value optionType_int8
value optionType_integer
value optionType_list
value optionType_map
value optionType_maybe
value optionType_set
value optionType_string
value optionType_word
value optionType_word16
value optionType_word32
value optionType_word64
value optionType_word8
value parseOptions
value parseSubcommand
value parsedArguments
value parsedError
value parsedHelp
value parsedOptions
value parsedSubcommand
value runCommand
value runSubcommand
value simpleOption
value subcommand
data Group
value groupDescription
value groupName
value groupTitle
data DefineOptions
data Option
value optionDefault
value optionDescription
value optionGroup
value optionLongFlags
value optionShortFlags
data OptionType
value optionTypeDefault
value optionTypeMerge
value optionTypeName
value optionTypeParse
value optionTypeShow
value optionTypeUnary
class Options
class Parsed
data ParsedOptions
data ParsedSubcommand
class SimpleOptionType
data Subcommand

Packageoptions-1.2.1.2
Exports59
LicenceMIT

valuedefaultOptions :: Options opts => opts

valuedefineOption :: OptionType a -> (Option a -> Option a) -> DefineOptions a

valuegroup :: String -> String -> String -> Group

valueoptionType

:: String
-> val
-> String -> Either String val
-> val -> String
-> OptionType val

valueoptionType_bool :: OptionType Bool

valueoptionType_double :: OptionType Double

valueoptionType_enum :: (Bounded a, Enum a, Show a) => String -> OptionType a

valueoptionType_float :: OptionType Float

valueoptionType_int :: OptionType Int

valueoptionType_int16 :: OptionType Int16

valueoptionType_int32 :: OptionType Int32

valueoptionType_int64 :: OptionType Int64

valueoptionType_int8 :: OptionType Int8

valueoptionType_integer :: OptionType Integer

valueoptionType_list :: Char -> OptionType a -> OptionType [a]

valueoptionType_map

:: Ord k
=> Char
-> Char
-> OptionType k
-> OptionType v
-> OptionType (Map k v)

valueoptionType_maybe :: OptionType a -> OptionType (Maybe a)

valueoptionType_set :: Ord a => Char -> OptionType a -> OptionType (Set a)

valueoptionType_string :: OptionType String

valueoptionType_word :: OptionType Word

valueoptionType_word16 :: OptionType Word16

valueoptionType_word32 :: OptionType Word32

valueoptionType_word64 :: OptionType Word64

valueoptionType_word8 :: OptionType Word8

valueparseOptions :: Options opts => [String] -> ParsedOptions opts

valueparseSubcommand

:: Options cmdOpts
=> [Subcommand cmdOpts action]
-> [String]
-> ParsedSubcommand action

valueparsedArguments :: ParsedOptions opts -> [String]

valueparsedError :: Parsed a => a -> Maybe String

valueparsedHelp :: Parsed a => a -> String

valueparsedOptions :: ParsedOptions opts -> Maybe opts

valueparsedSubcommand :: ParsedSubcommand action -> Maybe action

valuerunCommand :: (MonadIO m, Options opts) => (opts -> [String] -> m a) -> m a

valuerunSubcommand :: (Options opts, MonadIO m) => [Subcommand opts (m a)] -> m a

valuesimpleOption

:: SimpleOptionType a
=> String
-> a
-> String
-> DefineOptions a

valuesubcommand

:: (Options cmdOpts, Options subcmdOpts)
=> String
-> cmdOpts -> subcmdOpts -> [String] -> action
-> Subcommand cmdOpts action

datadata Group

valuegroupDescription :: Group -> String

valuegroupName :: Group -> String

valuegroupTitle :: Group -> String

datadata DefineOptions a

Instances2Functor, Applicative

Functor DefineOptionsDefined in options-1.2.1.2 · Options
Applicative DefineOptionsDefined in options-1.2.1.2 · Options

datadata Option a

valueoptionDefault :: Option a -> a

valueoptionDescription :: Option a -> String

valueoptionGroup :: Option a -> Maybe Group

valueoptionLongFlags :: Option a -> [String]

valueoptionShortFlags :: Option a -> [Char]

datadata OptionType val

valueoptionTypeDefault :: OptionType val -> val

valueoptionTypeMerge :: OptionType val -> Maybe ([val] -> val)

valueoptionTypeName :: OptionType val -> String

valueoptionTypeParse :: OptionType val -> String -> Either String val

valueoptionTypeShow :: OptionType val -> val -> String

valueoptionTypeUnary :: OptionType val -> Maybe val

classclass Options opts where

Methods

defineOptions :: DefineOptions opts

classclass Parsed a where

Instances2Parsed

Parsed (ParsedOptions a)Defined in options-1.2.1.2 · Options
Parsed (ParsedSubcommand a)Defined in options-1.2.1.2 · Options

datadata ParsedOptions opts

Instances1Parsed

Parsed (ParsedOptions a)Defined in options-1.2.1.2 · Options

datadata ParsedSubcommand action

Instances1Parsed

Parsed (ParsedSubcommand a)Defined in options-1.2.1.2 · Options

classclass SimpleOptionType a where

Methods

simpleOptionType :: OptionType a

Instances16SimpleOptionType, …

SimpleOptionType StringDefined in options-1.2.1.2 · Options
SimpleOptionType IntegerDefined in options-1.2.1.2 · Options
SimpleOptionType Int16Defined in options-1.2.1.2 · Options
SimpleOptionType Int32Defined in options-1.2.1.2 · Options
SimpleOptionType Int64Defined in options-1.2.1.2 · Options
SimpleOptionType Int8Defined in options-1.2.1.2 · Options
SimpleOptionType BoolDefined in options-1.2.1.2 · Options
SimpleOptionType DoubleDefined in options-1.2.1.2 · Options
SimpleOptionType FloatDefined in options-1.2.1.2 · Options
SimpleOptionType IntDefined in options-1.2.1.2 · Options
SimpleOptionType WordDefined in options-1.2.1.2 · Options
SimpleOptionType Word16Defined in options-1.2.1.2 · Options
SimpleOptionType Word32Defined in options-1.2.1.2 · Options
SimpleOptionType Word64Defined in options-1.2.1.2 · Options
SimpleOptionType Word8Defined in options-1.2.1.2 · Options
SimpleOptionType a => SimpleOptionType (Maybe a)Defined in options-1.2.1.2 · Options

datadata Subcommand cmdOpts action