Data.Encoding

Documentation

class Encoding enc where

Represents an encoding, supporting various methods of de- and encoding. Minimal complete definition: encode, decode

Methods

encode :: enc -> String -> ByteString

Encode a String into a strict ByteString. Throws the HasNoRepresentation-Exception if it encounters an unrepresentable character.

encodeLazy :: enc -> String -> ByteString

Encode a String into a lazy Data.ByteString.Lazy.ByteString.

encodable :: enc -> Char -> Bool

Whether or not the given Char is representable in this encoding. Default: True.

decode :: enc -> ByteString -> String

Decode a strict ByteString into a String. If the string is not decodable, a DecodingException is thrown.

decodeLazy :: enc -> ByteString -> String

decodable :: enc -> ByteString -> Bool

Whether or no a given ByteString is decodable. Default: True.

Instances

Encoding ASCII

Encoding UTF8

Encoding UTF16

Encoding UTF32

Encoding ISO88591

Encoding ISO88592

Encoding ISO88593

Encoding ISO88594

Encoding ISO88595

Encoding ISO88596

Encoding ISO88597

Encoding ISO88598

Encoding ISO88599

Encoding ISO885910

Encoding ISO885911

Encoding ISO885913

Encoding ISO885914

Encoding ISO885915

Encoding ISO885916

Encoding CP1250

Encoding CP1251

Encoding CP1252

Encoding CP1253

Encoding CP1254

Encoding CP1255

Encoding CP1256

Encoding CP1257

Encoding CP1258

Encoding KOI8R

Encoding KOI8U

Encoding GB18030

Encoding BootString

Encoding DynEncoding

data EncodingException

This exception type is thrown whenever something went wrong during the encoding-process.

Constructors

HasNoRepresentation Char

Thrown if a specific character is not representable in an encoding.

Instances

Eq EncodingException

Show EncodingException

Typeable EncodingException

data DecodingException

This exception type is thrown whenever something went wrong during the decoding-process.

Constructors

IllegalCharacter Word8

The sequence contained an illegal byte that couldn't be decoded.

UnexpectedEnd

more bytes were needed to allow a successfull decoding.

OutOfRange

the decoded value was out of the unicode range

IllegalRepresentation [Word8]

The character sequence encodes a character, but is illegal.

Instances

Eq DecodingException

Show DecodingException

Typeable DecodingException

recode :: (Encoding from, Encoding to) => from -> to -> ByteString -> ByteString

This decodes a string from one encoding and encodes it into another.

recodeLazy :: (Encoding from, Encoding to) => from -> to -> ByteString -> ByteString

data DynEncoding

An untyped encoding. Used in System.IO.Encoding.getSystemEncoding.

Instances

Eq DynEncoding

Show DynEncoding

Encoding DynEncoding

encodingFromString :: String -> DynEncoding

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

encodingFromStringMaybe :: String -> Maybe DynEncoding

Like encodingFromString but returns Nothing instead of throwing an error