Text.LambdaOptions.Keyword

Documentation

data Keyword

An option keyword, such as "--help"

Constructors

Keyword

Fields

kwNames :: [String]

All the aliases for this keyword.

kwArgText :: String

Text to describe the arguments to the option given by this keyword.

kwText :: String

Text to describe the function of the option given by this keyword.

Instances

Eq Keyword

Data Keyword

Ord Keyword

Show Keyword

IsString Keyword

ToKeyword Keyword

Identiy mapping.

Typeable * Keyword

class ToKeyword a where

Convenience Keyword creation class.

Methods

toKeyword :: a -> Keyword

Instances

ToKeyword String

Used to create a Keyword with a single alias.

ToKeyword Keyword

Identiy mapping.

ToKeyword [String]

Used to create a Keyword with many (or no) aliases

kw :: ToKeyword a => a -> Keyword

Shorthand for toKeyword.

argText :: Keyword -> String -> Keyword

Sets the kwArgText field in the keyword. Intended to be used infix:

kw "--directory" `argText` "DIR" `text` "Write files to DIR."

text :: Keyword -> String -> Keyword

Sets the kwText field in the keyword. Intended to be used infix.

kw "--quiet" `text` "Suppress message display."