Options.Applicative.Builder.Internal

data Mod f a

An option modifier.

Option modifiers are values that represent a modification of the properties of an option.

The type parameter @a@ is the pure type of the option, while @f@ is a record containing its properties (e.g. 'OptionFields' for regular options, 'FlagFields' for flags, etc...).

An option modifier consists of 3 elements:

• A field modifier, of the form @f a -> f a@. These are essentially (compositions of) setters for some of the properties supported by @f@.

• An optional default value and function to display it.

• A property modifier, of the form @OptProperties -> OptProperties@. This is just like the field modifier, but for properties applicable to any option.

Modifiers are instances of 'Monoid', and can be composed as such.

One rarely needs to deal with modifiers directly, as most of the times it is sufficient to pass them to builders (such as 'strOption' or 'flag') to create options (see 'Options.Applicative.Builder').

Contraints are often used to ensure that the modifiers can be sensibly applied. For example, positional arguments can't be specified by long or short names, so the 'HasName' constraint is used to ensure we have a flag or option.

Constructors

• Mod (f a -> f a) (DefaultProp a) (OptProperties -> OptProperties)

Instances

• Monoid (Mod f a)
• Semigroup (Mod f a)

  @since 0.13.0.0

class HasName f  where

Members

• name :: forall a. OptName -> f a -> f a

Instances

• HasName OptionFields
• HasName FlagFields

class HasCompleter f  where

Members

• modCompleter :: forall a. (Completer -> Completer) -> f a -> f a

Instances

• HasCompleter OptionFields
• HasCompleter ArgumentFields

class HasValue f  where

Members

• hasValueDummy :: forall a. f a -> Unit

Instances

• HasValue OptionFields
• HasValue ArgumentFields

class HasMetavar f  where

Members

• hasMetavarDummy :: forall a. f a -> Unit

Instances

• HasMetavar OptionFields
• HasMetavar ArgumentFields
• HasMetavar CommandFields

newtype OptionFields a

Constructors

• OptionFields { optCompleter :: Completer, optNames :: Array OptName, optNoArgError :: String -> ParseError }

Instances

• Newtype (OptionFields a) _
• HasName OptionFields
• HasCompleter OptionFields
• HasValue OptionFields
• HasMetavar OptionFields

newtype FlagFields a

Constructors

• FlagFields { flagActive :: a, flagNames :: Array OptName }

Instances

• Newtype (FlagFields a) _
• HasName FlagFields

newtype CommandFields a

Constructors

• CommandFields { cmdCommands :: Array (Tuple String (ParserInfo a)), cmdGroup :: Maybe String }

Instances

• Newtype (CommandFields a) _
• HasMetavar CommandFields

newtype ArgumentFields a

Constructors

• ArgumentFields { argCompleter :: Completer }

Instances

• Newtype (ArgumentFields a) _
• HasCompleter ArgumentFields
• HasValue ArgumentFields
• HasMetavar ArgumentFields

data DefaultProp a

Constructors

• DefaultProp (Maybe a) (Maybe (a -> String))

Instances

• Monoid (DefaultProp a)
• Semigroup (DefaultProp a)

optionMod :: forall f a. (OptProperties -> OptProperties) -> Mod f a

fieldMod :: forall f a. (f a -> f a) -> Mod f a

baseProps :: OptProperties

Base default properties.

mkCommand :: forall a. Mod CommandFields a -> Tuple3 (Maybe String) (Array String) (String -> Maybe (ParserInfo a))

mkParser :: forall a. DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Parser a

mkOption :: forall a. DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Option a

mkProps :: forall a. DefaultProp a -> (OptProperties -> OptProperties) -> OptProperties

internal :: forall f a. Mod f a

Hide this option from the help text