| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Data.TypedEncoding.Common.Types.Exceptions
Description
Internal definition of types
Synopsis
- data RecreateEx where
- RecreateEx :: (Show e, KnownSymbol x) => Proxy x -> e -> RecreateEx
- RecreateExUnkStep :: Show e => e -> RecreateEx
- recreateErrUnknown :: Show e => e -> RecreateEx
- data EncodeEx where
- EncodeEx :: (Show a, KnownSymbol x) => Proxy x -> a -> EncodeEx
- asEncodeEx :: (Show a, KnownSymbol x) => Proxy x -> Either a b -> Either EncodeEx b
- encToRecrEx :: EncodeEx -> RecreateEx
- mergeEncodeEx :: KnownSymbol x => Proxy x -> EncodeEx -> Maybe EncodeEx -> EncodeEx
- emptyEncErr :: KnownSymbol x => Proxy x -> EncodeEx
- data UnexpectedDecodeEx where
- UnexpectedDecodeEx :: (Show a, KnownSymbol x) => Proxy x -> a -> UnexpectedDecodeEx
- mergeErrs :: err -> (err -> Maybe err -> err) -> Either err a -> Either err b -> Either err c
Documentation
>>>:set -XOverloadedStrings -XMultiParamTypeClasses -XDataKinds -XAllowAmbiguousTypes>>>import qualified Data.Text as T
data RecreateEx where Source #
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 Source # | |
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 Source # | |
Defined in Data.TypedEncoding.Instances.Restriction.Misc Methods validation :: Validation (Either RecreateEx) "r-Int-decimal" "r-Int-decimal" c str Source # | |
| IsStringR str => Validate (Either RecreateEx) "r-Word8-decimal" "r-Word8-decimal" c str Source # | |
Defined in Data.TypedEncoding.Instances.Restriction.Misc Methods validation :: Validation (Either RecreateEx) "r-Word8-decimal" "r-Word8-decimal" c str Source # | |
| RecreateErr (Either RecreateEx) Source # | |
Defined in Data.TypedEncoding.Common.Class.Validate Methods recoveryErr :: RecreateEx -> Either RecreateEx a Source # | |
recreateErrUnknown :: Show e => e -> RecreateEx Source #
Represents errors in encoding
Constructors
| EncodeEx :: (Show a, KnownSymbol x) => Proxy x -> a -> EncodeEx |
Instances
| Show EncodeEx Source # | |
| (Ban s, Algorithm s "r-ban", IsStringR str) => Encode (Either EncodeEx) s "r-ban" c str Source # | |
| Char8Find str => Encode (Either EncodeEx) "r-ASCII" "r-ASCII" c str Source # | |
| Encode (Either EncodeEx) "r-ASCII" "r-ASCII" c Char Source # | |
| IsStringR str => Encode (Either EncodeEx) "r-Int-decimal" "r-Int-decimal" c str Source # | |
| Encode (Either EncodeEx) "r-UTF8" "r-UTF8" c ByteString Source # | |
| Encode (Either EncodeEx) "r-UTF8" "r-UTF8" c ByteString Source # | UTF8 encodings are defined for ByteString only as that would not make much sense for Text
Following test uses \(b :: B.ByteString) -> verEncoding b (fmap (fromEncoding . decodeAll . proxiedId (Proxy :: Proxy (Enc '["r-UTF8"] _ _))) . (encodeFAll :: _ -> Either EncodeEx _). toEncoding () $ b) |
| IsStringR str => Encode (Either EncodeEx) "r-Word8-decimal" "r-Word8-decimal" c str Source # | |
asEncodeEx :: (Show a, KnownSymbol x) => Proxy x -> Either a b -> Either EncodeEx b Source #
encToRecrEx :: EncodeEx -> RecreateEx Source #
Useful when manually recreating using recovery
mergeEncodeEx :: KnownSymbol x => Proxy x -> EncodeEx -> Maybe EncodeEx -> EncodeEx Source #
emptyEncErr :: KnownSymbol x => Proxy x -> EncodeEx Source #
data UnexpectedDecodeEx where Source #
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 Source # | |
Defined in Data.TypedEncoding.Common.Types.Exceptions Methods showsPrec :: Int -> UnexpectedDecodeEx -> ShowS # show :: UnexpectedDecodeEx -> String # showList :: [UnexpectedDecodeEx] -> ShowS # | |
| UnexpectedDecodeErr (Either UnexpectedDecodeEx) Source # | |
Defined in Data.TypedEncoding.Common.Class.Decode Methods unexpectedDecodeErr :: UnexpectedDecodeEx -> Either UnexpectedDecodeEx a Source # | |