| Maintainer | defanor <defanor@uberspace.net> |
|---|---|
| Stability | unstable |
| Portability | non-portable (uses GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Coalpit.Core
Description
Synopsis
- class Coalpit a where
- fromArgs :: Coalpit a => Options -> [String] -> Either String a
- data Usage
- usage :: Coalpit a => Options -> Proxy a -> Usage
- usageString :: Coalpit a => Options -> Proxy a -> String
- data Options = Options {
- fieldSeparator :: Char
- conNameMod :: String -> String
- selNameMod :: String -> String
- alwaysUseSelName :: Bool
- omitNamedOptions :: Bool
- timeLocale :: TimeLocale
- dateFormat :: String
- timeFormat :: String
- dateTimeFormat :: String
- scientificFormat :: FPFormat
- scientificDecimals :: Maybe Int
- uriUserInfo :: String -> String
- defOpt :: Options
Documentation
class Coalpit a where Source #
Coalpit class: parsing, printing, usage strings.
Minimal complete definition
Nothing
Methods
argParser :: Options -> Parser a Source #
argParser :: (Generic a, GCoalpit (Rep a)) => Options -> Parser a Source #
toArgs :: Options -> a -> [String] Source #
toArgs :: (Generic a, GCoalpit (Rep a)) => Options -> a -> [String] Source #
argHelper :: Options -> [String] -> Proxy a -> Usage Source #
argHelper :: GCoalpit (Rep a) => Options -> [String] -> Proxy a -> Usage Source #
Instances
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". |
Options
Printing and parsing options.
Constructors
| Options | |
Fields
| |