Data.TypedEncoding.Instances.Base64

Documentation

>>> :set -XScopedTypeVariables -XKindSignatures -XMultiParamTypeClasses -XDataKinds -XPolyKinds -XPartialTypeSignatures -XFlexibleInstances
>>> import Test.QuickCheck
>>> import Test.QuickCheck.Instances.Text()
>>> import Test.QuickCheck.Instances.ByteString()

byteString2TextS :: Enc ("enc-B64" ': ("r-UTF8" ': ys)) c ByteString -> Enc ("enc-B64" ': ys) c Text

Type-safer version of Byte-string to text conversion that prevent invalid UTF8 bytestrings to be conversted to B64 encoded Text.

byteString2TextL :: Enc ("enc-B64" ': ("r-UTF8" ': ys)) c ByteString -> Enc ("enc-B64" ': ys) c Text

text2ByteStringS :: Enc ("enc-B64" ': ys) c Text -> Enc ("enc-B64" ': ("r-UTF8" ': ys)) c ByteString

Converts encoded text to ByteString adding "r-UTF8" annotation. The question is why "r-UTF8", not for example, "r-UTF16"? No reason, there maybe a diffrent combinator for that in the future or one that accepts a proxy.

text2ByteStringL :: Enc ("enc-B64" ': ys) c Text -> Enc ("enc-B64" ': ("r-UTF8" ': ys)) c ByteString

byteString2TextS' :: Enc ("enc-B64" ': ys) c ByteString -> Enc ("enc-B64-nontext" ': ys) c Text

B64 encoded bytestring can be converted to Text as "enc-B64-nontext" preventing it from being B64-decoded directly to Text

byteString2TextL' :: Enc ("enc-B64" ': ys) c ByteString -> Enc ("enc-B64-nontext" ': ys) c Text

text2ByteStringS' :: Enc ("enc-B64-nontext" ': ys) c Text -> Enc ("enc-B64" ': ys) c ByteString

text2ByteStringL' :: Enc ("enc-B64-nontext" ': ys) c Text -> Enc ("enc-B64" ': ys) c ByteString

acceptLenientS :: Enc ("enc-B64-len" ': ys) c ByteString -> Enc ("enc-B64" ': ys) c ByteString

acceptLenientL :: Enc ("enc-B64-len" ': ys) c ByteString -> Enc ("enc-B64" ': ys) c ByteString

prxyB64 :: Proxy "enc-B64"

Orphan instances

FlattenAs "enc-B64" "r-ASCII"

Methods

flattenAs :: Proxy "r-ASCII" -> Enc ("enc-B64" ': xs) c str -> Enc ("r-ASCII" ': []) c str

FlattenAs "enc-B64-nontext" "r-ASCII"

allow to treat B64 encodings as ASCII forgetting about B64 encoding

>>> let tstB64 = encodeAll . toEncoding () $ "Hello World" :: Enc '["enc-B64"] () B.ByteString
>>> displ (flattenAs (Proxy :: Proxy "r-ASCII") tstB64 :: Enc '["r-ASCII"] () B.ByteString)
"MkEnc '[r-ASCII] () (ByteString SGVsbG8gV29ybGQ=)"

Methods

flattenAs :: Proxy "r-ASCII" -> Enc ("enc-B64-nontext" ': xs) c str -> Enc ("r-ASCII" ': []) c str

(RecreateErr f, Applicative f) => RecreateF (f :: Type -> Type) (Enc xs c Text :: Type) (Enc ("enc-B64" ': xs) c Text)

Methods

checkPrevF :: Enc ("enc-B64" ': xs) c Text -> f (Enc xs c Text)

(RecreateErr f, Applicative f) => RecreateF (f :: Type -> Type) (Enc xs c Text :: Type) (Enc ("enc-B64" ': xs) c Text)

Methods

checkPrevF :: Enc ("enc-B64" ': xs) c Text -> f (Enc xs c Text)

Applicative f => RecreateF (f :: Type -> Type) (Enc xs c ByteString :: Type) (Enc ("enc-B64-len" ': xs) c ByteString)

Methods

checkPrevF :: Enc ("enc-B64-len" ': xs) c ByteString -> f (Enc xs c ByteString)

(RecreateErr f, Applicative f) => RecreateF (f :: Type -> Type) (Enc xs c ByteString :: Type) (Enc ("enc-B64" ': xs) c ByteString)

Methods

checkPrevF :: Enc ("enc-B64" ': xs) c ByteString -> f (Enc xs c ByteString)

Applicative f => RecreateF (f :: Type -> Type) (Enc xs c ByteString :: Type) (Enc ("enc-B64-len" ': xs) c ByteString)

Methods

checkPrevF :: Enc ("enc-B64-len" ': xs) c ByteString -> f (Enc xs c ByteString)

(RecreateErr f, Applicative f) => RecreateF (f :: Type -> Type) (Enc xs c ByteString :: Type) (Enc ("enc-B64" ': xs) c ByteString)

Methods

checkPrevF :: Enc ("enc-B64" ': xs) c ByteString -> f (Enc xs c ByteString)

(UnexpectedDecodeErr f, Applicative f) => DecodeF (f :: Type -> Type) (Enc ("enc-B64" ': xs) c Text) (Enc xs c Text :: Type)

Methods

decodeF :: Enc ("enc-B64" ': xs) c Text -> f (Enc xs c Text)

(UnexpectedDecodeErr f, Applicative f) => DecodeF (f :: Type -> Type) (Enc ("enc-B64" ': xs) c Text) (Enc xs c Text :: Type)

Methods

decodeF :: Enc ("enc-B64" ': xs) c Text -> f (Enc xs c Text)

(UnexpectedDecodeErr f, Applicative f) => DecodeF (f :: Type -> Type) (Enc ("enc-B64" ': xs) c ByteString) (Enc xs c ByteString :: Type)

Methods

decodeF :: Enc ("enc-B64" ': xs) c ByteString -> f (Enc xs c ByteString)

(UnexpectedDecodeErr f, Applicative f) => DecodeF (f :: Type -> Type) (Enc ("enc-B64" ': xs) c ByteString) (Enc xs c ByteString :: Type)

Effectful instance for corruption detection. This protocol is used, for example, in emails. It is a well known encoding and hackers will have no problem making undetectable changes, but error handling at this stage could verify that email was corrupted.

Methods

decodeF :: Enc ("enc-B64" ': xs) c ByteString -> f (Enc xs c ByteString)

Applicative f => EncodeF (f :: Type -> Type) (Enc xs c Text) (Enc ("enc-B64" ': xs) c Text :: Type)

Methods

encodeF :: Enc xs c Text -> f (Enc ("enc-B64" ': xs) c Text)

Applicative f => EncodeF (f :: Type -> Type) (Enc xs c Text) (Enc ("enc-B64" ': xs) c Text :: Type)

Methods

encodeF :: Enc xs c Text -> f (Enc ("enc-B64" ': xs) c Text)

Applicative f => EncodeF (f :: Type -> Type) (Enc xs c ByteString) (Enc ("enc-B64" ': xs) c ByteString :: Type)

Methods

encodeF :: Enc xs c ByteString -> f (Enc ("enc-B64" ': xs) c ByteString)

Applicative f => EncodeF (f :: Type -> Type) (Enc xs c ByteString) (Enc ("enc-B64" ': xs) c ByteString :: Type)

Methods

encodeF :: Enc xs c ByteString -> f (Enc ("enc-B64" ': xs) c ByteString)