Data.TypedEncoding.Common.Types.Exceptions

Internal definition of types

Documentation

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

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.Common.Types.Exceptions

Methods

showsPrec :: Int -> RecreateEx -> ShowS

show :: RecreateEx -> String

showList :: [RecreateEx] -> ShowS

IsStringR str => Validate (Either RecreateEx) "r-Int-decimal" "r-Int-decimal" c str

Defined in Data.TypedEncoding.Instances.Restriction.Misc

Methods

validation :: Validation (Either RecreateEx) "r-Int-decimal" "r-Int-decimal" c str

IsStringR str => Validate (Either RecreateEx) "r-Word8-decimal" "r-Word8-decimal" c str

Defined in Data.TypedEncoding.Instances.Restriction.Misc

Methods

validation :: Validation (Either RecreateEx) "r-Word8-decimal" "r-Word8-decimal" c str

RecreateErr (Either RecreateEx)

Defined in Data.TypedEncoding.Common.Class.Validate

Methods

recoveryErr :: RecreateEx -> Either RecreateEx a

recreateErrUnknown :: Show e => e -> RecreateEx

data EncodeEx where

Represents errors in encoding

Constructors

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

Instances

Show EncodeEx

Defined in Data.TypedEncoding.Common.Types.Exceptions

Methods

showsPrec :: Int -> EncodeEx -> ShowS

show :: EncodeEx -> String

showList :: [EncodeEx] -> ShowS

(Ban s, Algorithm s "r-ban", IsStringR str) => Encode (Either EncodeEx) s "r-ban" c str

Defined in Data.TypedEncoding.Instances.Restriction.BoundedAlphaNums

Methods

encoding :: Encoding (Either EncodeEx) s "r-ban" c str

Char8Find str => Encode (Either EncodeEx) "r-ASCII" "r-ASCII" c str

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encoding :: Encoding (Either EncodeEx) "r-ASCII" "r-ASCII" c str

Encode (Either EncodeEx) "r-ASCII" "r-ASCII" c Char

Defined in Data.TypedEncoding.Instances.Restriction.ASCII

Methods

encoding :: Encoding (Either EncodeEx) "r-ASCII" "r-ASCII" c Char

IsStringR str => Encode (Either EncodeEx) "r-Int-decimal" "r-Int-decimal" c str

Defined in Data.TypedEncoding.Instances.Restriction.Misc

Methods

encoding :: Encoding (Either EncodeEx) "r-Int-decimal" "r-Int-decimal" c str

Encode (Either EncodeEx) "r-UTF8" "r-UTF8" c ByteString

Defined in Data.TypedEncoding.Instances.Restriction.UTF8

Methods

encoding :: Encoding (Either EncodeEx) "r-UTF8" "r-UTF8" c ByteString

Encode (Either EncodeEx) "r-UTF8" "r-UTF8" 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 (UnsafeMkEnc 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

encoding :: Encoding (Either EncodeEx) "r-UTF8" "r-UTF8" c ByteString

IsStringR str => Encode (Either EncodeEx) "r-Word8-decimal" "r-Word8-decimal" c str

Defined in Data.TypedEncoding.Instances.Restriction.Misc

Methods

encoding :: Encoding (Either EncodeEx) "r-Word8-decimal" "r-Word8-decimal" c str

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

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.Common.Types.Exceptions

Methods

showsPrec :: Int -> UnexpectedDecodeEx -> ShowS

show :: UnexpectedDecodeEx -> String

showList :: [UnexpectedDecodeEx] -> ShowS

UnexpectedDecodeErr (Either UnexpectedDecodeEx)

Defined in Data.TypedEncoding.Common.Class.Decode

Methods

unexpectedDecodeErr :: UnexpectedDecodeEx -> Either UnexpectedDecodeEx a

Base combinators that rely on types defined here

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