Data.TypedEncoding.Common.Types.Exceptions

Exception types used in typed-encoding

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

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 @since 0.1.0.0

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

Encode (Either EncodeEx) "r-B64" "r-B64" c String

Defined in Data.TypedEncoding.Instances.Restriction.Base64

Methods

encoding :: Encoding (Either EncodeEx) "r-B64" "r-B64" c String

Encode (Either EncodeEx) "r-B64" "r-B64" c Text

Defined in Data.TypedEncoding.Instances.Restriction.Base64

Methods

encoding :: Encoding (Either EncodeEx) "r-B64" "r-B64" c Text

Encode (Either EncodeEx) "r-B64" "r-B64" c Text

Defined in Data.TypedEncoding.Instances.Restriction.Base64

Methods

encoding :: Encoding (Either EncodeEx) "r-B64" "r-B64" c Text

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

Defined in Data.TypedEncoding.Instances.Restriction.Base64

Methods

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

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

Defined in Data.TypedEncoding.Instances.Restriction.Base64

Methods

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

Encode (Either EncodeEx) "r-ByteRep" "r-ByteRep" c String

Defined in Data.TypedEncoding.Instances.Restriction.ByteRep

Methods

encoding :: Encoding (Either EncodeEx) "r-ByteRep" "r-ByteRep" c String

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

Defined in Data.TypedEncoding.Instances.Restriction.ByteRep

Methods

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

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

Defined in Data.TypedEncoding.Instances.Restriction.ByteRep

Methods

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

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

Defined in Data.TypedEncoding.Instances.Restriction.ByteRep

Methods

encoding :: Encoding (Either EncodeEx) "r-ByteRep" "r-ByteRep" 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-UNICODE.D76" "r-UNICODE.D76" c String

Defined in Data.TypedEncoding.Instances.Restriction.D76

Methods

encoding :: Encoding (Either EncodeEx) "r-UNICODE.D76" "r-UNICODE.D76" c String

Encode (Either EncodeEx) "r-UNICODE.D76" "r-UNICODE.D76" c Char

Defined in Data.TypedEncoding.Instances.Restriction.D76

Methods

encoding :: Encoding (Either EncodeEx) "r-UNICODE.D76" "r-UNICODE.D76" c Char

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

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

>>> _runEncodings encodings . toEncoding () $ "\xc3\x28" :: Either EncodeEx (Enc '["r-UTF8"] () B.ByteString)
Left (EncodeEx "r-UTF8" (Cannot decode byte '\xc3': ...

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

>>> :{
quickCheck $ \(b :: B.ByteString) -> verEncoding b $ fmap (
         fromEncoding 
         . decodeAll @'["r-UTF8"]
         ) . encodeFAll @'["r-UTF8"] @(Either EncodeEx)
         . toEncoding () $ b
:}
+++ OK, passed 100 tests.

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

Since: 0.2.2.0

encToRecrEx :: EncodeEx -> RecreateEx

Useful when manually recreating using recovery @since 0.2.2.0

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

Since: 0.2.1.0

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

Since: 0.2.1.0

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.

Since: 0.1.0.0

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

Since: 0.2.1.0