Text.Enum.Text

Documentation

class (Buildable e, Bounded e, Enum e, Eq e, Ord e, Show e, TextParsable e) => EnumText e where

our toolkit for enumerated types which should be defined as follows:

import Fmt
import Text.Enum.Text

data Foo = FOO_bar | FOO_bar_baz
  deriving (Bounded,Enum,Eq,Ord,Show)

instance EnumText     Foo
instance Buildable    Foo where build     = buildEnumText
instance TextParsable Foo where parseText = parseEnumText

Minimal complete definition

Nothing

Methods

configEnumText :: e -> EnumTextConfig

Configures the textual representation of e generated by renderEnumText.

renderEnumText :: e -> Text

Generate the standard textual representation according to configEnumText by default.

buildEnumText :: e -> Builder

Sames as renderEnumText, but generating a Builder.

parseEnumText :: Text -> Possibly e

Parses an e according to the renderEnumText render.

toFieldEnumText :: e -> ByteString

A cassava field encoder, using 'the renderEnumText' format.

fromFieldEnumText_ :: Monad m => ByteString -> m e

A cassava field parser using the renderEnumText format.

hashWithSaltEnumText :: Int -> e -> Int

For hashing e with the renderEnumText representation.

class TextParsable a where

a class for Text parsers.

Methods

parseText :: Text -> Possibly a

data EnumTextConfig

configures the default implementation of renderEnumText

Constructors

EnumTextConfig

Fields

• _etc_text_prep :: Text -> Text

  applied to the output of show once converted to Text; by default strips each data constructor up to and including the first '_'

• _etc_char_prep :: Char -> Char

  applied to each character of the outpout of _etc_text_prep

defaultEnumTextConfig :: EnumTextConfig