Data.Encoding

Documentation

module Data.Encoding.Exception

module Data.Encoding.ByteSource

module Data.Encoding.ByteSink

class Encoding enc where

The base class for all encodings. At least decodeChar, encodeChar and encodeable must be implemented.

Minimal complete definition

decodeChar, encodeChar, encodeable

Methods

decodeChar :: ByteSource m => enc -> m Char

Read a single character of a ByteSource

encodeChar :: ByteSink m => enc -> Char -> m ()

Encode a single character and write it to a ByteSink

decode :: ByteSource m => enc -> m String

Read characters from a ByteSource until it is empty

encode :: ByteSink m => enc -> String -> m ()

Encode a String and write it to a ByteSink

encodeable :: enc -> Char -> Bool

Tests whether a given character is representable in the Encoding. If this yields True, encodeChar must not fail. If it yields False, encodeChar _must_ throw an exception.

Instances

Encoding DynEncoding

Methods

decodeChar :: ByteSource m => DynEncoding -> m Char

encodeChar :: ByteSink m => DynEncoding -> Char -> m ()

decode :: ByteSource m => DynEncoding -> m String

encode :: ByteSink m => DynEncoding -> String -> m ()

encodeable :: DynEncoding -> Char -> Bool

Encoding ASCII

Methods

decodeChar :: ByteSource m => ASCII -> m Char

encodeChar :: ByteSink m => ASCII -> Char -> m ()

decode :: ByteSource m => ASCII -> m String

encode :: ByteSink m => ASCII -> String -> m ()

encodeable :: ASCII -> Char -> Bool

Encoding BootString

Methods

decodeChar :: ByteSource m => BootString -> m Char

encodeChar :: ByteSink m => BootString -> Char -> m ()

decode :: ByteSource m => BootString -> m String

encode :: ByteSink m => BootString -> String -> m ()

encodeable :: BootString -> Char -> Bool

Encoding UTF32

Methods

decodeChar :: ByteSource m => UTF32 -> m Char

encodeChar :: ByteSink m => UTF32 -> Char -> m ()

decode :: ByteSource m => UTF32 -> m String

encode :: ByteSink m => UTF32 -> String -> m ()

encodeable :: UTF32 -> Char -> Bool

Encoding CP1250

Methods

decodeChar :: ByteSource m => CP1250 -> m Char

encodeChar :: ByteSink m => CP1250 -> Char -> m ()

decode :: ByteSource m => CP1250 -> m String

encode :: ByteSink m => CP1250 -> String -> m ()

encodeable :: CP1250 -> Char -> Bool

Encoding CP1251

Methods

decodeChar :: ByteSource m => CP1251 -> m Char

encodeChar :: ByteSink m => CP1251 -> Char -> m ()

decode :: ByteSource m => CP1251 -> m String

encode :: ByteSink m => CP1251 -> String -> m ()

encodeable :: CP1251 -> Char -> Bool

Encoding CP1252

Methods

decodeChar :: ByteSource m => CP1252 -> m Char

encodeChar :: ByteSink m => CP1252 -> Char -> m ()

decode :: ByteSource m => CP1252 -> m String

encode :: ByteSink m => CP1252 -> String -> m ()

encodeable :: CP1252 -> Char -> Bool

Encoding CP1253

Methods

decodeChar :: ByteSource m => CP1253 -> m Char

encodeChar :: ByteSink m => CP1253 -> Char -> m ()

decode :: ByteSource m => CP1253 -> m String

encode :: ByteSink m => CP1253 -> String -> m ()

encodeable :: CP1253 -> Char -> Bool

Encoding CP1254

Methods

decodeChar :: ByteSource m => CP1254 -> m Char

encodeChar :: ByteSink m => CP1254 -> Char -> m ()

decode :: ByteSource m => CP1254 -> m String

encode :: ByteSink m => CP1254 -> String -> m ()

encodeable :: CP1254 -> Char -> Bool

Encoding CP1255

Methods

decodeChar :: ByteSource m => CP1255 -> m Char

encodeChar :: ByteSink m => CP1255 -> Char -> m ()

decode :: ByteSource m => CP1255 -> m String

encode :: ByteSink m => CP1255 -> String -> m ()

encodeable :: CP1255 -> Char -> Bool

Encoding CP1256

Methods

decodeChar :: ByteSource m => CP1256 -> m Char

encodeChar :: ByteSink m => CP1256 -> Char -> m ()

decode :: ByteSource m => CP1256 -> m String

encode :: ByteSink m => CP1256 -> String -> m ()

encodeable :: CP1256 -> Char -> Bool

Encoding CP1257

Methods

decodeChar :: ByteSource m => CP1257 -> m Char

encodeChar :: ByteSink m => CP1257 -> Char -> m ()

decode :: ByteSource m => CP1257 -> m String

encode :: ByteSink m => CP1257 -> String -> m ()

encodeable :: CP1257 -> Char -> Bool

Encoding CP1258

Methods

decodeChar :: ByteSource m => CP1258 -> m Char

encodeChar :: ByteSink m => CP1258 -> Char -> m ()

decode :: ByteSource m => CP1258 -> m String

encode :: ByteSink m => CP1258 -> String -> m ()

encodeable :: CP1258 -> Char -> Bool

Encoding CP437

Methods

decodeChar :: ByteSource m => CP437 -> m Char

encodeChar :: ByteSink m => CP437 -> Char -> m ()

decode :: ByteSource m => CP437 -> m String

encode :: ByteSink m => CP437 -> String -> m ()

encodeable :: CP437 -> Char -> Bool

Encoding CP737

Methods

decodeChar :: ByteSource m => CP737 -> m Char

encodeChar :: ByteSink m => CP737 -> Char -> m ()

decode :: ByteSource m => CP737 -> m String

encode :: ByteSink m => CP737 -> String -> m ()

encodeable :: CP737 -> Char -> Bool

Encoding CP775

Methods

decodeChar :: ByteSource m => CP775 -> m Char

encodeChar :: ByteSink m => CP775 -> Char -> m ()

decode :: ByteSource m => CP775 -> m String

encode :: ByteSink m => CP775 -> String -> m ()

encodeable :: CP775 -> Char -> Bool

Encoding CP850

Methods

decodeChar :: ByteSource m => CP850 -> m Char

encodeChar :: ByteSink m => CP850 -> Char -> m ()

decode :: ByteSource m => CP850 -> m String

encode :: ByteSink m => CP850 -> String -> m ()

encodeable :: CP850 -> Char -> Bool

Encoding CP852

Methods

decodeChar :: ByteSource m => CP852 -> m Char

encodeChar :: ByteSink m => CP852 -> Char -> m ()

decode :: ByteSource m => CP852 -> m String

encode :: ByteSink m => CP852 -> String -> m ()

encodeable :: CP852 -> Char -> Bool

Encoding CP855

Methods

decodeChar :: ByteSource m => CP855 -> m Char

encodeChar :: ByteSink m => CP855 -> Char -> m ()

decode :: ByteSource m => CP855 -> m String

encode :: ByteSink m => CP855 -> String -> m ()

encodeable :: CP855 -> Char -> Bool

Encoding CP857

Methods

decodeChar :: ByteSource m => CP857 -> m Char

encodeChar :: ByteSink m => CP857 -> Char -> m ()

decode :: ByteSource m => CP857 -> m String

encode :: ByteSink m => CP857 -> String -> m ()

encodeable :: CP857 -> Char -> Bool

Encoding CP860

Methods

decodeChar :: ByteSource m => CP860 -> m Char

encodeChar :: ByteSink m => CP860 -> Char -> m ()

decode :: ByteSource m => CP860 -> m String

encode :: ByteSink m => CP860 -> String -> m ()

encodeable :: CP860 -> Char -> Bool

Encoding CP861

Methods

decodeChar :: ByteSource m => CP861 -> m Char

encodeChar :: ByteSink m => CP861 -> Char -> m ()

decode :: ByteSource m => CP861 -> m String

encode :: ByteSink m => CP861 -> String -> m ()

encodeable :: CP861 -> Char -> Bool

Encoding CP862

Methods

decodeChar :: ByteSource m => CP862 -> m Char

encodeChar :: ByteSink m => CP862 -> Char -> m ()

decode :: ByteSource m => CP862 -> m String

encode :: ByteSink m => CP862 -> String -> m ()

encodeable :: CP862 -> Char -> Bool

Encoding CP863

Methods

decodeChar :: ByteSource m => CP863 -> m Char

encodeChar :: ByteSink m => CP863 -> Char -> m ()

decode :: ByteSource m => CP863 -> m String

encode :: ByteSink m => CP863 -> String -> m ()

encodeable :: CP863 -> Char -> Bool

Encoding CP864

Methods

decodeChar :: ByteSource m => CP864 -> m Char

encodeChar :: ByteSink m => CP864 -> Char -> m ()

decode :: ByteSource m => CP864 -> m String

encode :: ByteSink m => CP864 -> String -> m ()

encodeable :: CP864 -> Char -> Bool

Encoding CP865

Methods

decodeChar :: ByteSource m => CP865 -> m Char

encodeChar :: ByteSink m => CP865 -> Char -> m ()

decode :: ByteSource m => CP865 -> m String

encode :: ByteSink m => CP865 -> String -> m ()

encodeable :: CP865 -> Char -> Bool

Encoding CP866

Methods

decodeChar :: ByteSource m => CP866 -> m Char

encodeChar :: ByteSink m => CP866 -> Char -> m ()

decode :: ByteSource m => CP866 -> m String

encode :: ByteSink m => CP866 -> String -> m ()

encodeable :: CP866 -> Char -> Bool

Encoding CP869

Methods

decodeChar :: ByteSource m => CP869 -> m Char

encodeChar :: ByteSink m => CP869 -> Char -> m ()

decode :: ByteSource m => CP869 -> m String

encode :: ByteSink m => CP869 -> String -> m ()

encodeable :: CP869 -> Char -> Bool

Encoding CP874

Methods

decodeChar :: ByteSource m => CP874 -> m Char

encodeChar :: ByteSink m => CP874 -> Char -> m ()

decode :: ByteSource m => CP874 -> m String

encode :: ByteSink m => CP874 -> String -> m ()

encodeable :: CP874 -> Char -> Bool

Encoding CP932

Methods

decodeChar :: ByteSource m => CP932 -> m Char

encodeChar :: ByteSink m => CP932 -> Char -> m ()

decode :: ByteSource m => CP932 -> m String

encode :: ByteSink m => CP932 -> String -> m ()

encodeable :: CP932 -> Char -> Bool

Encoding GB18030

Methods

decodeChar :: ByteSource m => GB18030 -> m Char

encodeChar :: ByteSink m => GB18030 -> Char -> m ()

decode :: ByteSource m => GB18030 -> m String

encode :: ByteSink m => GB18030 -> String -> m ()

encodeable :: GB18030 -> Char -> Bool

Encoding ISO88591

Methods

decodeChar :: ByteSource m => ISO88591 -> m Char

encodeChar :: ByteSink m => ISO88591 -> Char -> m ()

decode :: ByteSource m => ISO88591 -> m String

encode :: ByteSink m => ISO88591 -> String -> m ()

encodeable :: ISO88591 -> Char -> Bool

Encoding ISO885910

Methods

decodeChar :: ByteSource m => ISO885910 -> m Char

encodeChar :: ByteSink m => ISO885910 -> Char -> m ()

decode :: ByteSource m => ISO885910 -> m String

encode :: ByteSink m => ISO885910 -> String -> m ()

encodeable :: ISO885910 -> Char -> Bool

Encoding ISO885911

Methods

decodeChar :: ByteSource m => ISO885911 -> m Char

encodeChar :: ByteSink m => ISO885911 -> Char -> m ()

decode :: ByteSource m => ISO885911 -> m String

encode :: ByteSink m => ISO885911 -> String -> m ()

encodeable :: ISO885911 -> Char -> Bool

Encoding ISO885913

Methods

decodeChar :: ByteSource m => ISO885913 -> m Char

encodeChar :: ByteSink m => ISO885913 -> Char -> m ()

decode :: ByteSource m => ISO885913 -> m String

encode :: ByteSink m => ISO885913 -> String -> m ()

encodeable :: ISO885913 -> Char -> Bool

Encoding ISO885914

Methods

decodeChar :: ByteSource m => ISO885914 -> m Char

encodeChar :: ByteSink m => ISO885914 -> Char -> m ()

decode :: ByteSource m => ISO885914 -> m String

encode :: ByteSink m => ISO885914 -> String -> m ()

encodeable :: ISO885914 -> Char -> Bool

Encoding ISO885915

Methods

decodeChar :: ByteSource m => ISO885915 -> m Char

encodeChar :: ByteSink m => ISO885915 -> Char -> m ()

decode :: ByteSource m => ISO885915 -> m String

encode :: ByteSink m => ISO885915 -> String -> m ()

encodeable :: ISO885915 -> Char -> Bool

Encoding ISO885916

Methods

decodeChar :: ByteSource m => ISO885916 -> m Char

encodeChar :: ByteSink m => ISO885916 -> Char -> m ()

decode :: ByteSource m => ISO885916 -> m String

encode :: ByteSink m => ISO885916 -> String -> m ()

encodeable :: ISO885916 -> Char -> Bool

Encoding ISO88592

Methods

decodeChar :: ByteSource m => ISO88592 -> m Char

encodeChar :: ByteSink m => ISO88592 -> Char -> m ()

decode :: ByteSource m => ISO88592 -> m String

encode :: ByteSink m => ISO88592 -> String -> m ()

encodeable :: ISO88592 -> Char -> Bool

Encoding ISO88593

Methods

decodeChar :: ByteSource m => ISO88593 -> m Char

encodeChar :: ByteSink m => ISO88593 -> Char -> m ()

decode :: ByteSource m => ISO88593 -> m String

encode :: ByteSink m => ISO88593 -> String -> m ()

encodeable :: ISO88593 -> Char -> Bool

Encoding ISO88594

Methods

decodeChar :: ByteSource m => ISO88594 -> m Char

encodeChar :: ByteSink m => ISO88594 -> Char -> m ()

decode :: ByteSource m => ISO88594 -> m String

encode :: ByteSink m => ISO88594 -> String -> m ()

encodeable :: ISO88594 -> Char -> Bool

Encoding ISO88595

Methods

decodeChar :: ByteSource m => ISO88595 -> m Char

encodeChar :: ByteSink m => ISO88595 -> Char -> m ()

decode :: ByteSource m => ISO88595 -> m String

encode :: ByteSink m => ISO88595 -> String -> m ()

encodeable :: ISO88595 -> Char -> Bool

Encoding ISO88596

Methods

decodeChar :: ByteSource m => ISO88596 -> m Char

encodeChar :: ByteSink m => ISO88596 -> Char -> m ()

decode :: ByteSource m => ISO88596 -> m String

encode :: ByteSink m => ISO88596 -> String -> m ()

encodeable :: ISO88596 -> Char -> Bool

Encoding ISO88597

Methods

decodeChar :: ByteSource m => ISO88597 -> m Char

encodeChar :: ByteSink m => ISO88597 -> Char -> m ()

decode :: ByteSource m => ISO88597 -> m String

encode :: ByteSink m => ISO88597 -> String -> m ()

encodeable :: ISO88597 -> Char -> Bool

Encoding ISO88598

Methods

decodeChar :: ByteSource m => ISO88598 -> m Char

encodeChar :: ByteSink m => ISO88598 -> Char -> m ()

decode :: ByteSource m => ISO88598 -> m String

encode :: ByteSink m => ISO88598 -> String -> m ()

encodeable :: ISO88598 -> Char -> Bool

Encoding ISO88599

Methods

decodeChar :: ByteSource m => ISO88599 -> m Char

encodeChar :: ByteSink m => ISO88599 -> Char -> m ()

decode :: ByteSource m => ISO88599 -> m String

encode :: ByteSink m => ISO88599 -> String -> m ()

encodeable :: ISO88599 -> Char -> Bool

Encoding JISX0201

Methods

decodeChar :: ByteSource m => JISX0201 -> m Char

encodeChar :: ByteSink m => JISX0201 -> Char -> m ()

decode :: ByteSource m => JISX0201 -> m String

encode :: ByteSink m => JISX0201 -> String -> m ()

encodeable :: JISX0201 -> Char -> Bool

Encoding JISX0208

Methods

decodeChar :: ByteSource m => JISX0208 -> m Char

encodeChar :: ByteSink m => JISX0208 -> Char -> m ()

decode :: ByteSource m => JISX0208 -> m String

encode :: ByteSink m => JISX0208 -> String -> m ()

encodeable :: JISX0208 -> Char -> Bool

Encoding ISO2022JP

Methods

decodeChar :: ByteSource m => ISO2022JP -> m Char

encodeChar :: ByteSink m => ISO2022JP -> Char -> m ()

decode :: ByteSource m => ISO2022JP -> m String

encode :: ByteSink m => ISO2022JP -> String -> m ()

encodeable :: ISO2022JP -> Char -> Bool

Encoding JISX0212

Methods

decodeChar :: ByteSource m => JISX0212 -> m Char

encodeChar :: ByteSink m => JISX0212 -> Char -> m ()

decode :: ByteSource m => JISX0212 -> m String

encode :: ByteSink m => JISX0212 -> String -> m ()

encodeable :: JISX0212 -> Char -> Bool

Encoding KOI8R

Methods

decodeChar :: ByteSource m => KOI8R -> m Char

encodeChar :: ByteSink m => KOI8R -> Char -> m ()

decode :: ByteSource m => KOI8R -> m String

encode :: ByteSink m => KOI8R -> String -> m ()

encodeable :: KOI8R -> Char -> Bool

Encoding KOI8U

Methods

decodeChar :: ByteSource m => KOI8U -> m Char

encodeChar :: ByteSink m => KOI8U -> Char -> m ()

decode :: ByteSource m => KOI8U -> m String

encode :: ByteSink m => KOI8U -> String -> m ()

encodeable :: KOI8U -> Char -> Bool

Encoding MacOSRoman

Methods

decodeChar :: ByteSource m => MacOSRoman -> m Char

encodeChar :: ByteSink m => MacOSRoman -> Char -> m ()

decode :: ByteSource m => MacOSRoman -> m String

encode :: ByteSink m => MacOSRoman -> String -> m ()

encodeable :: MacOSRoman -> Char -> Bool

Encoding ShiftJIS

Methods

decodeChar :: ByteSource m => ShiftJIS -> m Char

encodeChar :: ByteSink m => ShiftJIS -> Char -> m ()

decode :: ByteSource m => ShiftJIS -> m String

encode :: ByteSink m => ShiftJIS -> String -> m ()

encodeable :: ShiftJIS -> Char -> Bool

Encoding UTF16

Methods

decodeChar :: ByteSource m => UTF16 -> m Char

encodeChar :: ByteSink m => UTF16 -> Char -> m ()

decode :: ByteSource m => UTF16 -> m String

encode :: ByteSink m => UTF16 -> String -> m ()

encodeable :: UTF16 -> Char -> Bool

Encoding UTF8

Methods

decodeChar :: ByteSource m => UTF8 -> m Char

encodeChar :: ByteSink m => UTF8 -> Char -> m ()

decode :: ByteSource m => UTF8 -> m String

encode :: ByteSink m => UTF8 -> String -> m ()

encodeable :: UTF8 -> Char -> Bool

data DynEncoding

Wraps all possible encoding types into one data type. Used when a function needs to return an encoding.

Instances

Eq DynEncoding

Methods

(==) :: DynEncoding -> DynEncoding -> Bool

(/=) :: DynEncoding -> DynEncoding -> Bool

Show DynEncoding

Methods

showsPrec :: Int -> DynEncoding -> ShowS

show :: DynEncoding -> String

showList :: [DynEncoding] -> ShowS

Encoding DynEncoding

Methods

decodeChar :: ByteSource m => DynEncoding -> m Char

encodeChar :: ByteSink m => DynEncoding -> Char -> m ()

decode :: ByteSource m => DynEncoding -> m String

encode :: ByteSink m => DynEncoding -> String -> m ()

encodeable :: DynEncoding -> Char -> Bool

recode :: (Encoding enc1, Encoding enc2, ByteSource m, ByteSink m) => enc1 -> enc2 -> m ()

encodeString :: Encoding enc => enc -> String -> String

encodeStringExplicit :: Encoding enc => enc -> String -> Either EncodingException String

decodeString :: Encoding enc => enc -> String -> String

decodeStringExplicit :: Encoding enc => enc -> String -> Either DecodingException String

encodeLazyByteString :: Encoding enc => enc -> String -> ByteString

encodeLazyByteStringExplicit :: Encoding enc => enc -> String -> Either EncodingException ByteString

decodeLazyByteString :: Encoding enc => enc -> ByteString -> String

decodeLazyByteStringExplicit :: Encoding enc => enc -> ByteString -> Either DecodingException String

encodeStrictByteString :: Encoding enc => enc -> String -> ByteString

encodeStrictByteStringExplicit :: Encoding enc => enc -> String -> Either EncodingException ByteString

decodeStrictByteString :: Encoding enc => enc -> ByteString -> String

decodeStrictByteStringExplicit :: Encoding enc => enc -> ByteString -> Either DecodingException String

encodingFromString :: String -> DynEncoding

Takes the name of an encoding and creates a dynamic encoding from it.

encodingFromStringExplicit :: String -> Maybe DynEncoding

Like encodingFromString but returns Nothing instead of throwing an error