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

With the DeriveAnyClass language extension you can list EnumText in the deriving clause, and with DerivingVia (available from GHC 8.6.1) you can derive via UsingEnumText as follows:

{-# LANGUAGE DeriveAnyClass    #-}
{-# LANGUAGE DerivingVia       #-}

import Fmt
import Text.Enum.Text

data Foo = FOO_bar | FOO_bar_baz
  deriving (Bounded,Enum,EnumText,Eq,Ord,Show)
  deriving (Buildable,TextParsable) via UsingEnumText Foo

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_ :: MonadFail m => ByteString -> m e

A cassava field parser using the renderEnumText format.

hashWithSaltEnumText :: Int -> e -> Int

For hashing e with the renderEnumText representation.

newtype UsingEnumText a

Constructors

UsingEnumText

Fields

• _UsingEnumText :: a

Instances

EnumText a => Buildable (UsingEnumText a)

Defined in Text.Enum.Text

Methods

build :: UsingEnumText a -> Builder

EnumText a => TextParsable (UsingEnumText a)

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly (UsingEnumText a)

class TextParsable a where

a class for Text parsers.

Methods

parseText :: Text -> Possibly a

Instances

TextParsable Int

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly Int

TextParsable Text

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly Text

TextParsable UTCTime

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly UTCTime

TextParsable Day

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly Day

a ~ Char => TextParsable [a]

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly [a]

TextParsable a => TextParsable (Maybe a)

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly (Maybe a)

EnumText a => TextParsable (UsingEnumText a)

Defined in Text.Enum.Text

Methods

parseText :: Text -> Possibly (UsingEnumText 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 (by default flips underscores (_) to dashes (-)

defaultEnumTextConfig :: EnumTextConfig

The default configEnumText for EnumText:

• _etc_text_prep removes the prefix up to and including the first underscore ('_')
• _etc_char_prep flips the underscores (_) to dashes (-)