Data.TypedEncoding.Common.Class.Common

This module defines SymbolList and Displ type classes using by typed-encoding used for display / testing as well as for construction of untyped versions of Enc (CheckedEnc and UncheckedEnc)

This module is re-exported in Data.TypedEncoding and it is best not to import it directly.

Documentation

>>> :set -XScopedTypeVariables -XTypeApplications -XAllowAmbiguousTypes -XDataKinds

Symbol List

class SymbolList (xs :: [Symbol]) where

Since: 0.2.0.0

Methods

symbolVals :: [String]

Instances

SymbolList ([] :: [Symbol])

Defined in Data.TypedEncoding.Common.Class.Common

Methods

symbolVals :: [String]

(SymbolList xs, KnownSymbol x) => SymbolList (x ': xs)

>>> symbolVals @ '["FIRST", "SECOND"]
["FIRST","SECOND"]

Defined in Data.TypedEncoding.Common.Class.Common

Methods

symbolVals :: [String]

symbolVals_ :: forall xs. SymbolList xs => Proxy xs -> [String]

Display

class Displ x where

Human friendly version of Show

Since: 0.2.0.0

Methods

displ :: x -> String

Instances

Displ String

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: String -> String

Displ ByteString

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: ByteString -> String

Displ ByteString

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: ByteString -> String

Displ Text

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: Text -> String

Displ Text

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: Text -> String

Displ [EncAnn]

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: [EncAnn] -> String

Displ a => Displ (SimplifiedEmailF a)

Provides easy to read encoding information

Defined in Examples.TypedEncoding.ToEncString

Methods

displ :: SimplifiedEmailF a -> String

Displ a => Displ (IpV4F a)

Provides easy to read encoding information

Defined in Examples.TypedEncoding.ToEncString

Methods

displ :: IpV4F a -> String

SymbolList xs => Displ (Proxy xs)

>>> displ (Proxy :: Proxy ["FIRST", "SECOND"])
"[FIRST,SECOND]"

Defined in Data.TypedEncoding.Common.Class.Common

Methods

displ :: Proxy xs -> String

(Show c, Displ str) => Displ (UncheckedEnc c str)

>>> displ $ MkUncheckedEnc ["TEST"] () ("hello" :: T.Text)
"MkUncheckedEnc [TEST] () (Text hello)"

Defined in Data.TypedEncoding.Common.Types.UncheckedEnc

Methods

displ :: UncheckedEnc c str -> String

(Show c, Displ str) => Displ (CheckedEnc c str)

>>> displ $ unsafeCheckedEnc ["TEST"] () ("hello" :: T.Text)
"UnsafeMkCheckedEnc [TEST] () (Text hello)"

Defined in Data.TypedEncoding.Common.Types.CheckedEnc

Methods

displ :: CheckedEnc c str -> String

(Show c, Displ str) => Displ (SomeEnc c str)

>>> let enctest = unsafeSetPayload () "hello" :: Enc '["TEST"] () T.Text
>>> displ $ MkSomeEnc enctest
"Some (Enc '[TEST] () (Text hello))"

Defined in Examples.TypedEncoding.SomeEnc

Methods

displ :: SomeEnc c str -> String

(SymbolList xs, Show c, Displ str) => Displ (Enc xs c str)

>>> let disptest = UnsafeMkEnc Proxy () "hello" :: Enc '["TEST"] () T.Text
>>> displ disptest
"Enc '[TEST] () (Text hello)"

Defined in Data.TypedEncoding.Common.Types.Enc

Methods

displ :: Enc xs c str -> String