Coalpit.Core

The Coalpit class with instances, a few functions to work with it, and Options are defined here.

Documentation

class Coalpit a where

Coalpit class: parsing, printing, usage strings.

Minimal complete definition

Nothing

Methods

argParser :: Options -> Parser a

argParser :: (Generic a, GCoalpit (Rep a)) => Options -> Parser a

toArgs :: Options -> a -> [String]

toArgs :: (Generic a, GCoalpit (Rep a)) => Options -> a -> [String]

argHelper :: Options -> [String] -> Proxy a -> Usage

argHelper :: GCoalpit (Rep a) => Options -> [String] -> Proxy a -> Usage

Instances

Coalpit Bool

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Bool

toArgs :: Options -> Bool -> [String]

argHelper :: Options -> [String] -> Proxy Bool -> Usage

Coalpit Char

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Char

toArgs :: Options -> Char -> [String]

argHelper :: Options -> [String] -> Proxy Char -> Usage

Coalpit Double

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Double

toArgs :: Options -> Double -> [String]

argHelper :: Options -> [String] -> Proxy Double -> Usage

Coalpit Float

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Float

toArgs :: Options -> Float -> [String]

argHelper :: Options -> [String] -> Proxy Float -> Usage

Coalpit Int

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Int

toArgs :: Options -> Int -> [String]

argHelper :: Options -> [String] -> Proxy Int -> Usage

Coalpit Int8

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Int8

toArgs :: Options -> Int8 -> [String]

argHelper :: Options -> [String] -> Proxy Int8 -> Usage

Coalpit Int16

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Int16

toArgs :: Options -> Int16 -> [String]

argHelper :: Options -> [String] -> Proxy Int16 -> Usage

Coalpit Int32

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Int32

toArgs :: Options -> Int32 -> [String]

argHelper :: Options -> [String] -> Proxy Int32 -> Usage

Coalpit Int64

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Int64

toArgs :: Options -> Int64 -> [String]

argHelper :: Options -> [String] -> Proxy Int64 -> Usage

Coalpit Integer

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Integer

toArgs :: Options -> Integer -> [String]

argHelper :: Options -> [String] -> Proxy Integer -> Usage

Coalpit Natural

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Natural

toArgs :: Options -> Natural -> [String]

argHelper :: Options -> [String] -> Proxy Natural -> Usage

Coalpit Ordering

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Ordering

toArgs :: Options -> Ordering -> [String]

argHelper :: Options -> [String] -> Proxy Ordering -> Usage

Coalpit Rational

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Rational

toArgs :: Options -> Rational -> [String]

argHelper :: Options -> [String] -> Proxy Rational -> Usage

Coalpit Word8

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Word8

toArgs :: Options -> Word8 -> [String]

argHelper :: Options -> [String] -> Proxy Word8 -> Usage

Coalpit Word16

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Word16

toArgs :: Options -> Word16 -> [String]

argHelper :: Options -> [String] -> Proxy Word16 -> Usage

Coalpit Word32

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Word32

toArgs :: Options -> Word32 -> [String]

argHelper :: Options -> [String] -> Proxy Word32 -> Usage

Coalpit Word64

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Word64

toArgs :: Options -> Word64 -> [String]

argHelper :: Options -> [String] -> Proxy Word64 -> Usage

Coalpit ()

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser ()

toArgs :: Options -> () -> [String]

argHelper :: Options -> [String] -> Proxy () -> Usage

Coalpit Version

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Version

toArgs :: Options -> Version -> [String]

argHelper :: Options -> [String] -> Proxy Version -> Usage

Coalpit ExitCode

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser ExitCode

toArgs :: Options -> ExitCode -> [String]

argHelper :: Options -> [String] -> Proxy ExitCode -> Usage

Coalpit String

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser String

toArgs :: Options -> String -> [String]

argHelper :: Options -> [String] -> Proxy String -> Usage

Coalpit Scientific

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Scientific

toArgs :: Options -> Scientific -> [String]

argHelper :: Options -> [String] -> Proxy Scientific -> Usage

Coalpit URI

An URI reference (absolute or relative).

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser URI

toArgs :: Options -> URI -> [String]

argHelper :: Options -> [String] -> Proxy URI -> Usage

Coalpit ZonedTime

Uses dateTimeFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser ZonedTime

toArgs :: Options -> ZonedTime -> [String]

argHelper :: Options -> [String] -> Proxy ZonedTime -> Usage

Coalpit LocalTime

Uses dateTimeFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser LocalTime

toArgs :: Options -> LocalTime -> [String]

argHelper :: Options -> [String] -> Proxy LocalTime -> Usage

Coalpit TimeOfDay

Uses timeFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser TimeOfDay

toArgs :: Options -> TimeOfDay -> [String]

argHelper :: Options -> [String] -> Proxy TimeOfDay -> Usage

Coalpit UniversalTime

Uses dateTimeFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser UniversalTime

toArgs :: Options -> UniversalTime -> [String]

argHelper :: Options -> [String] -> Proxy UniversalTime -> Usage

Coalpit UTCTime

Uses dateTimeFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser UTCTime

toArgs :: Options -> UTCTime -> [String]

argHelper :: Options -> [String] -> Proxy UTCTime -> Usage

Coalpit NominalDiffTime

Converts to/from Scientific.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser NominalDiffTime

toArgs :: Options -> NominalDiffTime -> [String]

argHelper :: Options -> [String] -> Proxy NominalDiffTime -> Usage

Coalpit DiffTime

Converts to/from Scientific.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser DiffTime

toArgs :: Options -> DiffTime -> [String]

argHelper :: Options -> [String] -> Proxy DiffTime -> Usage

Coalpit Day

Uses dateFormat.

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser Day

toArgs :: Options -> Day -> [String]

argHelper :: Options -> [String] -> Proxy Day -> Usage

Coalpit a => Coalpit [a]

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser [a]

toArgs :: Options -> [a] -> [String]

argHelper :: Options -> [String] -> Proxy [a] -> Usage

Coalpit a => Coalpit (Maybe a)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (Maybe a)

toArgs :: Options -> Maybe a -> [String]

argHelper :: Options -> [String] -> Proxy (Maybe a) -> Usage

Coalpit a => Coalpit (Complex a)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (Complex a)

toArgs :: Options -> Complex a -> [String]

argHelper :: Options -> [String] -> Proxy (Complex a) -> Usage

Coalpit a => Coalpit (NonEmpty a)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (NonEmpty a)

toArgs :: Options -> NonEmpty a -> [String]

argHelper :: Options -> [String] -> Proxy (NonEmpty a) -> Usage

(Coalpit a, Coalpit b) => Coalpit (Either a b)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (Either a b)

toArgs :: Options -> Either a b -> [String]

argHelper :: Options -> [String] -> Proxy (Either a b) -> Usage

(Coalpit a, Coalpit b) => Coalpit (a, b)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (a, b)

toArgs :: Options -> (a, b) -> [String]

argHelper :: Options -> [String] -> Proxy (a, b) -> Usage

(Coalpit a, Coalpit b, Coalpit c) => Coalpit (a, b, c)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (a, b, c)

toArgs :: Options -> (a, b, c) -> [String]

argHelper :: Options -> [String] -> Proxy (a, b, c) -> Usage

(Coalpit a, Coalpit b, Coalpit c, Coalpit d) => Coalpit (a, b, c, d)

Defined in Coalpit.Core

Methods

argParser :: Options -> Parser (a, b, c, d)

toArgs :: Options -> (a, b, c, d) -> [String]

argHelper :: Options -> [String] -> Proxy (a, b, c, d) -> Usage

fromArgs :: Coalpit a => Options -> [String] -> Either String a

Parses arguments.

Usage

data Usage

Usage description: can be translated into help messages or documentation formats.

Constructors

UConstructor String

Data constructor.

URecursive String

Constructor of a recursive data structure (its second appearance in the tree).

USelector String Usage

Record selector.

UOptional Usage

Optional element.

USum Usage Usage

Sum.

UProduct Usage Usage

Product.

UUnit

Unit.

UType String

Type name, e.g. "INT".

Instances

Show Usage

Defined in Coalpit.Core

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

usage :: Coalpit a => Options -> Proxy a -> Usage

Composes Usage description.

usageString :: Coalpit a => Options -> Proxy a -> String

Composes a usage string.

Options

data Options

Printing and parsing options.

Constructors

Options

Fields

• fieldSeparator :: Char

  DSV field separator (showDSV, readDSV).

• conNameMod :: String -> String

  Constructor name modifier.

• selNameMod :: String -> String

  Record selector name modifier.

• alwaysUseSelName :: Bool

  Add record selector name always, not just for optional arguments.

• omitNamedOptions :: Bool

  Omit named Maybe values to indicate Nothing.

• timeLocale :: TimeLocale
• dateFormat :: String

  See Data.Time.Format.

• timeFormat :: String
• dateTimeFormat :: String
• scientificFormat :: FPFormat
• scientificDecimals :: Maybe Int
• uriUserInfo :: String -> String

  Used to map userinfo parts of URIs.

defOpt :: Options

Default options.