Data.TypedEncoding.Pkg.Encoding.Instances

Key instances defined here are ToEncString and FromEncString. These allow to create encoded ByteString from a String (ToEncString) and decode ByteString back (ToEncString).

The String Encode, Decode instances is less interesting since is works with String type only.

See the warnings section of Data.TypedEncoding.Pkg.Encoding.Conv

Documentation

>>> :set -XOverloadedStrings -XDataKinds -XTypeApplications -XFlexibleContexts
>>> import           Data.Functor.Identity
>>> import qualified Data.TypedEncoding as Usage

Orphan instances

DynEnc s => EncodingSuperset s

All encoding encodings map characters to bytes This defines EncSuperset s as "r-CHAR8"

Associated Types

type EncSuperset s :: Symbol

Methods

implEncInto :: Enc (s ': xs) c str -> Enc (EncSuperset s ': (s ': xs)) c str

(UnexpectedDecodeErr f, Monad f, DynEnc s, Algorithm s "enc-pkg/encoding") => Decode f s "enc-pkg/encoding" c String

Methods

decoding :: Decoding f s "enc-pkg/encoding" c String

(DynEnc s, Algorithm s "enc-pkg/encoding") => ToEncString (Either EncodeEx) s "enc-pkg/encoding" String ByteString

Methods

toEncF :: String -> Either EncodeEx (Enc (s ': []) () ByteString)

(DynEnc s, Algorithm s "enc-pkg/encoding") => ToEncString (Either EncodeEx) s "enc-pkg/encoding" String ByteString

>>> :{
Usage.displ 
 <$> Usage.toEncStringF' 
  @"enc-pkg/encoding" 
  @"enc-pkg/encoding:cyrillic" 
  @(Either Usage.EncodeEx) 
  @String 
  @B.ByteString "Статья"
:}
Right "Enc '[enc-pkg/encoding:cyrillic] () (ByteString \193\226\208\226\236\239)"

Methods

toEncF :: String -> Either EncodeEx (Enc (s ': []) () ByteString)

(DynEnc s, Algorithm s "enc-pkg/encoding") => Encode (Either EncodeEx) s "enc-pkg/encoding" c String

Methods

encoding :: Encoding (Either EncodeEx) s "enc-pkg/encoding" c String

(UnexpectedDecodeErr f, Monad f, DynEnc s, Algorithm s "enc-pkg/encoding") => FromEncString (f :: Type -> Type) s "enc-pkg/encoding" String ByteString

Methods

fromEncF :: Enc (s ': []) () ByteString -> f String

(UnexpectedDecodeErr f, Monad f, DynEnc s, Algorithm s "enc-pkg/encoding") => FromEncString (f :: Type -> Type) s "enc-pkg/encoding" String ByteString

>>> :{
Usage.displ <$> 
 Usage.fromEncStringF' 
  @"enc-pkg/encoding" 
  @"enc-pkg/encoding:cyrillic" 
  @(Either Usage.UnexpectedDecodeEx) 
  @String @B.ByteString 
   (Typed.unsafeSetPayload () "\193\226\208\226\236\239")
:}
Right "(String \1057\1090\1072\1090\1100\1103)"

Methods

fromEncF :: Enc (s ': []) () ByteString -> f String