Data.TypedEncoding.Common.Class.Encode

Type classes accompanying decoding types defined in Data.TypedEncoding.Common.Types.Enc

Examples.TypedEncoding.Instances.DiySignEncoding contains an implementation example.

Examples.TypedEncoding.Overview shows decoding usage examples.

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.ByteString as B
>>> import Data.Functor.Identity
>>> import Data.TypedEncoding
>>> import Data.TypedEncoding.Instances.Enc.Base64 ()

class Encode f nm alg conf str where

Allows for polymorphic access to encoding, for example

>>> displ (runIdentity . _runEncoding encoding $ toEncoding () "Hello" :: Enc '["enc-B64"] () B.ByteString)
"Enc '[enc-B64] () (ByteString SGVsbG8=)"

Using 2 Symbol type variables (nm and alg) creates what seems like redundant typing in statically defined instances such as "r-ASCII", however it provides future flexibility to constrain nm in some interesting way, different than AlgNm nm ~ alg.

It also seems to be easier to understand as type variables used in the definition of Encoding match with what is on the typeclass.

alg is expected to be very statically defined and is needed to support more open instances such as "r-ban".

Since: 0.3.0.0

Methods

encoding :: Encoding f nm alg conf str

Instances

Applicative f => Encode f "enc-B64" "enc-B64" c Text

This instance will likely be removed in future versions (performance concerns) (Moved from Data.TypedEncoding.Instances.Enc.Base64)

Defined in Data.TypedEncoding.Instances.Enc.Warn.Base64

Methods

encoding :: Encoding f "enc-B64" "enc-B64" c Text

Applicative f => Encode f "enc-B64" "enc-B64" c ByteString

Since: 0.3.0.0

Defined in Data.TypedEncoding.Instances.Enc.Base64

Methods

encoding :: Encoding f "enc-B64" "enc-B64" c ByteString

Applicative f => Encode f "enc-B64" "enc-B64" c ByteString

Since: 0.3.0.0

Defined in Data.TypedEncoding.Instances.Enc.Base64

Methods

encoding :: Encoding f "enc-B64" "enc-B64" c ByteString

Applicative f => Encode f "my-sign" "my-sign" c Text

Because encoding function is pure we can create instance of Encode that is polymorphic in effect f.

This is done using implTranP combinator.

Defined in Examples.TypedEncoding.Instances.DiySignEncoding

Methods

encoding :: Encoding f "my-sign" "my-sign" c Text

(HasA SizeLimit c, Applicative f) => Encode f "do-size-limit" "do-size-limit" c ByteString

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-size-limit" "do-size-limit" c ByteString

(HasA SizeLimit c, Applicative f) => Encode f "do-size-limit" "do-size-limit" c Text

Since: 0.3.0.0

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-size-limit" "do-size-limit" c Text

Applicative f => Encode f "do-reverse" "do-reverse" c Text

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-reverse" "do-reverse" c Text

Applicative f => Encode f "do-reverse" "do-reverse" c Text

Since: 0.3.0.0

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-reverse" "do-reverse" c Text

Applicative f => Encode f "do-Title" "do-Title" c Text

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-Title" "do-Title" c Text

Applicative f => Encode f "do-Title" "do-Title" c Text

Since: 0.3.0.0

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-Title" "do-Title" c Text

Applicative f => Encode f "do-lower" "do-lower" c Text

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-lower" "do-lower" c Text

Applicative f => Encode f "do-lower" "do-lower" c Text

Since: 0.3.0.0

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-lower" "do-lower" c Text

Applicative f => Encode f "do-UPPER" "do-UPPER" c Text

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-UPPER" "do-UPPER" c Text

Applicative f => Encode f "do-UPPER" "do-UPPER" c Text

Since: 0.3.0.0

Defined in Examples.TypedEncoding.Instances.Do.Sample

Methods

encoding :: Encoding f "do-UPPER" "do-UPPER" c Text

(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

class EncodeAll f nms algs conf str where

Allows for polymorphic access to Encodings

For example

>>> displ (runIdentity . _runEncodings encodings $ toEncoding () "Hello" :: (Enc '["enc-B64", "enc-B64"] () B.ByteString))
"Enc '[enc-B64,enc-B64] () (ByteString U0dWc2JHOD0=)"

You can also use convenience functions like encodeAll

Since: 0.3.0.0

Methods

encodings :: Encodings f nms algs conf str

Instances

EncodeAll f ([] :: [Symbol]) ([] :: [Symbol]) conf str

Defined in Data.TypedEncoding.Common.Class.Encode

Methods

encodings :: Encodings f [] [] conf str

(EncodeAll f nms algs conf str, Encode f nm alg conf str) => EncodeAll f (nm ': nms) (alg ': algs) conf str

Defined in Data.TypedEncoding.Common.Class.Encode

Methods

encodings :: Encodings f (nm ': nms) (alg ': algs) conf str