encoding-0.2: A library for various character encodings Contents Index

Data.Encoding

Synopsis

class Encoding enc where encode :: enc -> String -> ByteString encodeLazy :: enc -> String -> ByteString encodable :: enc -> Char -> Bool decode :: enc -> ByteString -> String decodeLazy :: enc -> ByteString -> String decodable :: enc -> ByteString -> Bool data EncodingException = HasNoRepresentation Char data DecodingException = IllegalCharacter Word8 | UnexpectedEnd | OutOfRange data DynEncoding encodingFromString :: String -> DynEncoding

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 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 BootString Encoding CP1250 Encoding CP1251 Encoding CP1252 Encoding CP1253 Encoding CP1254 Encoding CP1255 Encoding CP1256 Encoding CP1257 Encoding CP1258 Encoding DynEncoding Encoding GB18030 Encoding ISO88591 Encoding ISO885910 Encoding ISO885911 Encoding ISO885913 Encoding ISO885914 Encoding ISO885915 Encoding ISO885916 Encoding ISO88592 Encoding ISO88593 Encoding ISO88594 Encoding ISO88595 Encoding ISO88596 Encoding ISO88597 Encoding ISO88598 Encoding ISO88599 Encoding KOI8R Encoding UTF16 Encoding UTF32 Encoding UTF8

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 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 Instances Show DecodingException Typeable DecodingException

data DynEncoding

An untyped encoding. Used in getSystemEncoding. Instances Encoding DynEncoding

encodingFromString :: String -> DynEncoding

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

Produced by Haddock version 0.8