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

Methods

(==) :: Keyword -> Keyword -> Bool

(/=) :: Keyword -> Keyword -> Bool

Data Keyword

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Keyword -> c Keyword

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Keyword

toConstr :: Keyword -> Constr

dataTypeOf :: Keyword -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Keyword)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Keyword)

gmapT :: (forall b. Data b => b -> b) -> Keyword -> Keyword

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Keyword -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Keyword -> r

gmapQ :: (forall d. Data d => d -> u) -> Keyword -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Keyword -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Keyword -> m Keyword

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Keyword -> m Keyword

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Keyword -> m Keyword

Ord Keyword

Methods

compare :: Keyword -> Keyword -> Ordering

(<) :: Keyword -> Keyword -> Bool

(<=) :: Keyword -> Keyword -> Bool

(>) :: Keyword -> Keyword -> Bool

(>=) :: Keyword -> Keyword -> Bool

max :: Keyword -> Keyword -> Keyword

min :: Keyword -> Keyword -> Keyword

Show Keyword

Methods

showsPrec :: Int -> Keyword -> ShowS

show :: Keyword -> String

showList :: [Keyword] -> ShowS

IsString Keyword

Methods

fromString :: String -> Keyword

ToKeyword Keyword

Identiy mapping.

Methods

toKeyword :: Keyword -> Keyword

class ToKeyword a where

Convenience Keyword creation class.

Minimal complete definition

toKeyword

Methods

toKeyword :: a -> Keyword

Instances

ToKeyword String

Used to create a Keyword with a single alias.

Methods

toKeyword :: String -> Keyword

ToKeyword Keyword

Identiy mapping.

Methods

toKeyword :: Keyword -> Keyword

ToKeyword [String]

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

Methods

toKeyword :: [String] -> Keyword

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."