Binrep.Type.Text

Documentation

type AsText (enc :: k) = Refined enc Text

A string of a given encoding, stored in the Text type.

Essentially Text carrying a proof that it can be successfully encoded into the given encoding. For example, AsText ASCII means the Text stored is pure ASCII.

class Encode (enc :: k) where

Bytestring encoders for text validated for a given encoding.

Methods

encode' :: Text -> Bytes

Encode text to bytes. Internal function, use encode.

Instances

Encode Ascii

We reuse UTF-8 encoding for ASCII, since it is a subset of UTF-8.

Defined in Binrep.Type.Text.Encoding.Ascii

Methods

encode' :: Text -> Bytes

Encode ShiftJis

Defined in Binrep.Type.Text.Encoding.ShiftJis

Methods

encode' :: Text -> Bytes

Encode Utf8

Defined in Binrep.Type.Text.Encoding.Utf8

Methods

encode' :: Text -> Bytes

Encode (Utf16 BE)

Defined in Binrep.Type.Text.Encoding.Utf16

Methods

encode' :: Text -> Bytes

Encode (Utf16 LE)

Defined in Binrep.Type.Text.Encoding.Utf16

Methods

encode' :: Text -> Bytes

Encode (Utf32 BE)

Defined in Binrep.Type.Text.Encoding.Utf32

Methods

encode' :: Text -> Bytes

Encode (Utf32 LE)

Defined in Binrep.Type.Text.Encoding.Utf32

Methods

encode' :: Text -> Bytes

encode :: forall {k} (enc :: k). Encode enc => AsText enc -> Bytes

Encode some validated text.

encodeToRep :: forall {k1} {k2} (rep :: k1) (enc :: k2). (Encode enc, Refine rep Bytes) => AsText enc -> Either RefineFailure (Refined rep Bytes)

Encode some text to a bytestring, asserting that the resulting value is valid for the requested bytestring representation.

This is intended to be used with visible type applications:

>>> let Right t = refine @UTF8 (Text.pack "hi")
>>> :t t
t :: AsText UTF8
>>> let Right bs = encodeToRep @'C t
>>> :t bs
bs :: Refined 'C Bytes

class Decode (enc :: k) where

Methods

decode :: Bytes -> Either String (AsText enc)

Decode a ByteString to Text with an explicit encoding.

This is intended to be used with visible type applications.

Instances

Decode Ascii

Defined in Binrep.Type.Text.Encoding.Ascii

Methods

decode :: Bytes -> Either String (AsText Ascii)

Decode ShiftJis

Defined in Binrep.Type.Text.Encoding.ShiftJis

Methods

decode :: Bytes -> Either String (AsText ShiftJis)

Decode Utf8

Defined in Binrep.Type.Text.Encoding.Utf8

Methods

decode :: Bytes -> Either String (AsText Utf8)

Decode (Utf16 BE)

Defined in Binrep.Type.Text.Encoding.Utf16

Methods

decode :: Bytes -> Either String (AsText (Utf16 BE))

Decode (Utf16 LE)

Defined in Binrep.Type.Text.Encoding.Utf16

Methods

decode :: Bytes -> Either String (AsText (Utf16 LE))

Decode (Utf32 BE)

Defined in Binrep.Type.Text.Encoding.Utf32

Methods

decode :: Bytes -> Either String (AsText (Utf32 BE))

Decode (Utf32 LE)

Defined in Binrep.Type.Text.Encoding.Utf32

Methods

decode :: Bytes -> Either String (AsText (Utf32 LE))

module Binrep.Type.Text.Encoding.Utf8

module Binrep.Type.Text.Encoding.Ascii

module Binrep.Type.Text.Encoding.Utf16

module Binrep.Type.Text.Encoding.Utf32

module Binrep.Type.Text.Encoding.ShiftJis