Safe Haskell	Safe-Inferred
Language	GHC2021

Binrep.Type.Text.Internal

Synopsis

type Bytes = ByteString
type AsText enc = Refined enc Text
class Encode enc where
- encode' :: Text -> Bytes
class Decode enc where
- decode :: Bytes -> Either String (AsText enc)
decodeText :: forall enc e. (e -> String) -> (Bytes -> Either e Text) -> Bytes -> Either String (AsText enc)
wrapUnsafeDecoder :: (Bytes -> Text) -> Bytes -> Either UnicodeException Text

Documentation

type Bytes = ByteString Source #

type AsText enc = Refined enc Text Source #

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 where Source #

Bytestring encoders for text validated for a given encoding.

Methods

encode' :: Text -> Bytes Source #

Encode text to bytes. Internal function, use encode.

Instances

Instances details

Encode Ascii Source #	We reuse UTF-8 encoding for ASCII, since it is a subset of UTF-8.
Instance details Defined in Binrep.Type.Text.Encoding.Ascii Methods encode' :: Text -> Bytes Source #
Encode ShiftJis Source #
Instance details Defined in Binrep.Type.Text.Encoding.ShiftJis Methods encode' :: Text -> Bytes Source #
Encode Utf8 Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf8 Methods encode' :: Text -> Bytes Source #
Encode (Utf16 BE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf16 Methods encode' :: Text -> Bytes Source #
Encode (Utf16 LE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf16 Methods encode' :: Text -> Bytes Source #
Encode (Utf32 BE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf32 Methods encode' :: Text -> Bytes Source #
Encode (Utf32 LE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf32 Methods encode' :: Text -> Bytes Source #

class Decode enc where Source #

Methods

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

Decode a ByteString to Text with an explicit encoding.

This is intended to be used with visible type applications.

Instances

Instances details

Decode Ascii Source #
Instance details Defined in Binrep.Type.Text.Encoding.Ascii Methods decode :: Bytes -> Either String (AsText Ascii) Source #
Decode ShiftJis Source #
Instance details Defined in Binrep.Type.Text.Encoding.ShiftJis Methods decode :: Bytes -> Either String (AsText ShiftJis) Source #
Decode Utf8 Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf8 Methods decode :: Bytes -> Either String (AsText Utf8) Source #
Decode (Utf16 BE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf16 Methods decode :: Bytes -> Either String (AsText (Utf16 BE)) Source #
Decode (Utf16 LE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf16 Methods decode :: Bytes -> Either String (AsText (Utf16 LE)) Source #
Decode (Utf32 BE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf32 Methods decode :: Bytes -> Either String (AsText (Utf32 BE)) Source #
Decode (Utf32 LE) Source #
Instance details Defined in Binrep.Type.Text.Encoding.Utf32 Methods decode :: Bytes -> Either String (AsText (Utf32 LE)) Source #

decodeText :: forall enc e. (e -> String) -> (Bytes -> Either e Text) -> Bytes -> Either String (AsText enc) Source #

Helper for decoding a Bytes to a Text tagged with its encoding.

wrapUnsafeDecoder :: (Bytes -> Text) -> Bytes -> Either UnicodeException Text Source #

Run an unsafe decoder safely.

Copied from Data.Text.Encoding.decodeUtf8', so should be bulletproof?