Data.TypedEncoding.Internal.Types

Internal definition of types

Documentation

data UnexpectedDecodeEx where

Type safety over encodings makes decoding process safe. However failures are still possible due to bugs or unsafe payload modifications. UnexpectedDecodeEx represents such errors.

Constructors

UnexpectedDecodeEx :: (Show a, KnownSymbol x) => Proxy x -> a -> UnexpectedDecodeEx

Instances

Show UnexpectedDecodeEx

Defined in Data.TypedEncoding.Internal.Types

Methods

showsPrec :: Int -> UnexpectedDecodeEx -> ShowS

show :: UnexpectedDecodeEx -> String

showList :: [UnexpectedDecodeEx] -> ShowS

UnexpectedDecodeErr (Either UnexpectedDecodeEx)

Defined in Data.TypedEncoding.Internal.Class.Decode

Methods

unexpectedDecodeErr :: UnexpectedDecodeEx -> Either UnexpectedDecodeEx a

data EncodeEx where

Represents errors in encoding

Constructors

EncodeEx :: (Show a, KnownSymbol x) => Proxy x -> a -> EncodeEx

Instances

Show EncodeEx

Defined in Data.TypedEncoding.Internal.Types

Methods

showsPrec :: Int -> EncodeEx -> ShowS

show :: EncodeEx -> String

showList :: [EncodeEx] -> ShowS

EncodeF (Either EncodeEx) (Enc xs c ByteString) (Enc ("r-UTF8" ': xs) c ByteString :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.UTF8

Methods

encodeF :: Enc xs c ByteString -> Either EncodeEx (Enc ("r-UTF8" ': xs) c ByteString)

EncodeF (Either EncodeEx) (Enc xs c ByteString) (Enc ("r-UTF8" ': xs) c ByteString :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.UTF8

Methods

encodeF :: Enc xs c ByteString -> Either EncodeEx (Enc ("r-UTF8" ': xs) c ByteString)

IsStringR str => EncodeF (Either EncodeEx) (Enc xs c str) (Enc ("r-Int-decimal" ': xs) c str :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.Common

Methods

encodeF :: Enc xs c str -> Either EncodeEx (Enc ("r-Int-decimal" ': xs) c str)

IsStringR str => EncodeF (Either EncodeEx) (Enc xs c str) (Enc ("r-Word8-decimal" ': xs) c str :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.Common

Methods

encodeF :: Enc xs c str -> Either EncodeEx (Enc ("r-Word8-decimal" ': xs) c str)

EncodeF (Either EncodeEx) (Enc xs c ByteString) (Enc ("r-ASCII" ': xs) c ByteString :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c ByteString -> Either EncodeEx (Enc ("r-ASCII" ': xs) c ByteString)

EncodeF (Either EncodeEx) (Enc xs c ByteString) (Enc ("r-ASCII" ': xs) c ByteString :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c ByteString -> Either EncodeEx (Enc ("r-ASCII" ': xs) c ByteString)

EncodeF (Either EncodeEx) (Enc xs c Text) (Enc ("r-ASCII" ': xs) c Text :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c Text -> Either EncodeEx (Enc ("r-ASCII" ': xs) c Text)

EncodeF (Either EncodeEx) (Enc xs c Text) (Enc ("r-ASCII" ': xs) c Text :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c Text -> Either EncodeEx (Enc ("r-ASCII" ': xs) c Text)

EncodeF (Either EncodeEx) (Enc xs c String) (Enc ("r-ASCII" ': xs) c String :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c String -> Either EncodeEx (Enc ("r-ASCII" ': xs) c String)

EncodeF (Either EncodeEx) (Enc xs c Char) (Enc ("r-ASCII" ': xs) c Char :: Type)

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodeF :: Enc xs c Char -> Either EncodeEx (Enc ("r-ASCII" ': xs) c Char)

(KnownSymbol s, "r-ban" ~ TakeUntil s ":", IsStringR str, Encodings (Either EncodeEx) xs grps c str) => Encodings (Either EncodeEx) (s ': xs) ("r-ban" ': grps) c str

Defined in Data.TypedEncoding.Combinators.Restriction.BoundedAlphaNums

Methods

encodings :: Encoder (Either EncodeEx) (s ': xs) ("r-ban" ': grps) c str

Encodings (Either EncodeEx) xs grps c ByteString => Encodings (Either EncodeEx) ("enc-B64" ': xs) ("enc-B64" ': grps) c ByteString

Defined in Data.TypedEncoding.Instances.Enc.Base64

Methods

encodings :: Encoder (Either EncodeEx) ("enc-B64" ': xs) ("enc-B64" ': grps) c ByteString

Encodings (Either EncodeEx) xs grps c ByteString => Encodings (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c ByteString

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodings :: Encoder (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c ByteString

Encodings (Either EncodeEx) xs grps c ByteString => Encodings (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c ByteString

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodings :: Encoder (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c ByteString

Encodings (Either EncodeEx) xs grps c Text => Encodings (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c Text

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodings :: Encoder (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c Text

Encodings (Either EncodeEx) xs grps c Text => Encodings (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c Text

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodings :: Encoder (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c Text

Encodings (Either EncodeEx) xs grps c String => Encodings (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c String

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encodings :: Encoder (Either EncodeEx) ("r-ASCII" ': xs) ("r-ASCII" ': grps) c String

Encodings (Either EncodeEx) xs grps c ByteString => Encodings (Either EncodeEx) ("r-UTF8" ': xs) ("r-UTF8" ': grps) c ByteString

Defined in Data.TypedEncoding.Instances.Restriction.UTF8

Methods

encodings :: Encoder (Either EncodeEx) ("r-UTF8" ': xs) ("r-UTF8" ': grps) c ByteString

Encodings (Either EncodeEx) xs grps c ByteString => Encodings (Either EncodeEx) ("r-UTF8" ': xs) ("r-UTF8" ': grps) c ByteString

UTF8 encodings are defined for ByteString only as that would not make much sense for Text

>>> encodeFAll . toEncoding () $ "\xc3\xb1" :: Either EncodeEx (Enc '["r-UTF8"] () B.ByteString)
Right (MkEnc Proxy () "\195\177")

>>> encodeFAll . toEncoding () $ "\xc3\x28" :: Either EncodeEx (Enc '["r-UTF8"] () B.ByteString)
Left (EncodeEx "r-UTF8" (Cannot decode byte '\xc3': Data.Text.Internal.Encoding.decodeUtf8: Invalid UTF-8 stream))

Following test uses verEncoding helper that checks that bytes are encoded as Right iff they are valid UTF8 bytes

\(b :: B.ByteString) -> verEncoding b (fmap (fromEncoding . decodeAll . proxiedId (Proxy :: Proxy (Enc '["r-UTF8"] _ _))) . (encodeFAll :: _ -> Either EncodeEx _). toEncoding () $ b)

Defined in Data.TypedEncoding.Instances.Restriction.UTF8

Methods

encodings :: Encoder (Either EncodeEx) ("r-UTF8" ': xs) ("r-UTF8" ': grps) c ByteString

data RecreateEx where

Represents errors in recovery (recreation of encoded types).

Constructors

RecreateEx :: (Show e, KnownSymbol x) => Proxy x -> e -> RecreateEx

RecreateExUnkStep :: Show e => e -> RecreateEx

Instances

Show RecreateEx

Defined in Data.TypedEncoding.Internal.Types

Methods

showsPrec :: Int -> RecreateEx -> ShowS

show :: RecreateEx -> String

showList :: [RecreateEx] -> ShowS

RecreateErr (Either RecreateEx)

Defined in Data.TypedEncoding.Internal.Class.Recreate

Methods

recoveryErr :: RecreateEx -> Either RecreateEx a

recreateErrUnknown :: Show e => e -> RecreateEx

asEncodeEx :: (Show a, KnownSymbol x) => Proxy x -> Either a b -> Either EncodeEx b

encToRecrEx :: EncodeEx -> RecreateEx

Useful when manually recreating using recovery

mergeEncodeEx :: KnownSymbol x => Proxy x -> EncodeEx -> Maybe EncodeEx -> EncodeEx

emptyEncErr :: KnownSymbol x => Proxy x -> EncodeEx

implEncodeF_ :: (Show err, KnownSymbol x) => Proxy x -> (str -> Either err str) -> Enc enc1 conf str -> Either EncodeEx (Enc enc2 conf str)

implEncodeF :: forall x enc1 enc2 err conf str. (Show err, KnownSymbol x) => (str -> Either err str) -> Enc enc1 conf str -> Either EncodeEx (Enc enc2 conf str)

implEncodeF_' :: (Show err, KnownSymbol x) => Proxy x -> (conf -> str -> Either err str) -> Enc enc1 conf str -> Either EncodeEx (Enc enc2 conf str)

mergeErrs :: err -> (err -> Maybe err -> err) -> Either err a -> Either err b -> Either err c

Main encoding type and basic combinators.

module Data.TypedEncoding.Internal.Types.Enc

Untyped version and existentially quantified versions of Enc

module Data.TypedEncoding.Internal.Types.CheckedEnc

Not verified encoded data

module Data.TypedEncoding.Internal.Types.UncheckedEnc

Commmon types

module Data.TypedEncoding.Internal.Types.Common