Data.TypedEncoding.Common.Types.UncheckedEnc

Defines UncheckedEnc representing not verified encoding and basic combinators for using it.

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

Documentation

>>> :set -XOverloadedStrings -XMultiParamTypeClasses -XDataKinds -XAllowAmbiguousTypes
>>> import qualified Data.Text as T

UncheckedEnc for validation, similar to CheckedEnc but not verified

data UncheckedEnc c str

Represents some encoded string where encoding was not validated.

Encoding is not tracked at the type level.

Similar to CheckedEnc but unlike CheckedEnc it can contain payloads that have invalid encoding.

See check

Since: 0.2.0.0

Constructors

MkUncheckedEnc [EncAnn] c str

Instances

(Eq c, Eq str) => Eq (UncheckedEnc c str)

Defined in Data.TypedEncoding.Common.Types.UncheckedEnc

Methods

(==) :: UncheckedEnc c str -> UncheckedEnc c str -> Bool

(/=) :: UncheckedEnc c str -> UncheckedEnc c str -> Bool

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

Defined in Data.TypedEncoding.Common.Types.UncheckedEnc

Methods

showsPrec :: Int -> UncheckedEnc c str -> ShowS

show :: UncheckedEnc c str -> String

showList :: [UncheckedEnc c str] -> ShowS

(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

toUncheckedEnc :: [EncAnn] -> c -> str -> UncheckedEnc c str

Since: 0.2.0.0

getUncheckedEncAnn :: UncheckedEnc c str -> [EncAnn]

Since: 0.2.0.0

getUncheckedPayload :: forall c str. UncheckedEnc c str -> str

verifyAnn :: forall xs c str. SymbolList xs => UncheckedEnc c str -> Either String (UncheckedEnc c str)

Since: 0.2.0.0