Optima

IO

params

Arguments

:: Text

Description of the application

-> Params a

-> IO a

Execute the parameters parser in IO, throwing an exception if anything goes wrong.

Params

data Params a

Parameters product parser. Should be used for composition of all application parameters.

Instances

Functor Params

Defined in Optima

Methods

fmap :: (a -> b) -> Params a -> Params b

(<$) :: a -> Params b -> Params a

Applicative Params

Defined in Optima

Methods

pure :: a -> Params a

(<*>) :: Params (a -> b) -> Params a -> Params b

liftA2 :: (a -> b -> c) -> Params a -> Params b -> Params c

(*>) :: Params a -> Params b -> Params b

(<*) :: Params a -> Params b -> Params a

Alternative Params

Defined in Optima

Methods

empty :: Params a

(<|>) :: Params a -> Params a -> Params a

some :: Params a -> Params [a]

many :: Params a -> Params [a]

param

Arguments

:: Maybe Char

Single-char name

-> Text

Long name

-> Param a

-> Params a

Lift a single parameter parser.

group

Arguments

:: Text

Prefix for the long names of the parameters. If empty, then there'll be no prefixing

-> ParamGroup a

-> Params a

Lift a parameter group parser.

The param group cannot use short names, only long names.

ParamGroup

data ParamGroup a

Parameter group, which gets identified by prefixing the names.

Should be used to define parameters, which only make sense in combination. E.g., a server config can be defined by providing port and host together.

Instances

Functor ParamGroup

Defined in Optima

Methods

fmap :: (a -> b) -> ParamGroup a -> ParamGroup b

(<$) :: a -> ParamGroup b -> ParamGroup a

Applicative ParamGroup

Defined in Optima

Methods

pure :: a -> ParamGroup a

(<*>) :: ParamGroup (a -> b) -> ParamGroup a -> ParamGroup b

liftA2 :: (a -> b -> c) -> ParamGroup a -> ParamGroup b -> ParamGroup c

(*>) :: ParamGroup a -> ParamGroup b -> ParamGroup b

(<*) :: ParamGroup a -> ParamGroup b -> ParamGroup a

Alternative ParamGroup

Defined in Optima

Methods

empty :: ParamGroup a

(<|>) :: ParamGroup a -> ParamGroup a -> ParamGroup a

some :: ParamGroup a -> ParamGroup [a]

many :: ParamGroup a -> ParamGroup [a]

member

Arguments

:: Text

Long name of the parameter

-> Param a

-> ParamGroup a

Lift a param parser into parameter group.

subgroup

Arguments

:: Text

Long name prefix

-> ParamGroup a

-> ParamGroup a

Unite a group by a shared prefix.

Param

data Param a

Parameter parser.

Includes the description of the parameter.

Instances

Functor Param

Defined in Optima

Methods

fmap :: (a -> b) -> Param a -> Param b

(<$) :: a -> Param b -> Param a

value

Arguments

:: Text

Description. Can be empty

-> Default a

Default value

-> ValueFormat a

Value format

-> Value a

-> Param a

Create a single parameter parser from a value parser and meta information.

flag

Arguments

:: Text

Description. Can be empty

-> Param ()

A parameter with no value. Fails if it's not present. Thus it can be composed using Alternative.

Value

data Value a

Parameter value parser.

Instances

Monad Value

Defined in Optima

Methods

(>>=) :: Value a -> (a -> Value b) -> Value b

(>>) :: Value a -> Value b -> Value b

return :: a -> Value a

fail :: String -> Value a

Functor Value

Defined in Optima

Methods

fmap :: (a -> b) -> Value a -> Value b

(<$) :: a -> Value b -> Value a

MonadFail Value

Defined in Optima

Methods

fail :: String -> Value a

Applicative Value

Defined in Optima

Methods

pure :: a -> Value a

(<*>) :: Value (a -> b) -> Value a -> Value b

liftA2 :: (a -> b -> c) -> Value a -> Value b -> Value c

(*>) :: Value a -> Value b -> Value b

(<*) :: Value a -> Value b -> Value a

Alternative Value

Defined in Optima

Methods

empty :: Value a

(<|>) :: Value a -> Value a -> Value a

some :: Value a -> Value [a]

many :: Value a -> Value [a]

MonadPlus Value

Defined in Optima

Methods

mzero :: Value a

mplus :: Value a -> Value a -> Value a

explicitlyParsed :: Parser a -> Value a

Lift an Attoparsec parser into value parser.

implicitlyParsed :: LenientParser a => Value a

Lift an implicit lenient Attoparsec parser into value parser.

Default

data Default a

Default value with its textual representation.

Instances

Functor Default

Defined in Optima

Methods

fmap :: (a -> b) -> Default a -> Default b

(<$) :: a -> Default b -> Default a

explicitlyRepresented :: (a -> Text) -> a -> Default a

Provide a default value with explicit textual representation.

showable :: Show a => a -> Default a

Provide a default value with textual representation formed using the implicit Show instance.

defaultless :: Default a

Provide no default value.

ValueFormat

data ValueFormat a

Parameter description.

Instances

Functor ValueFormat

Defined in Optima

Methods

fmap :: (a -> b) -> ValueFormat a -> ValueFormat b

(<$) :: a -> ValueFormat b -> ValueFormat a

formattedByEnum :: (Bounded a, Enum a) => (a -> Text) -> ValueFormat a

Derive value format specification from the Enum instance and explicit mapping of values to their representations.

formattedByEnumUsingShow :: (Bounded a, Enum a, Show a) => ValueFormat a

Derive value format specification from the Enum and Show instances.

unformatted :: ValueFormat a

Avoid specifying the format.