encoding-0.4.1: A library for various character encodings Source code 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 | IllegalRepresentation [Word8] recode :: (Encoding from, Encoding to) => from -> to -> ByteString -> ByteString recodeLazy :: (Encoding from, Encoding to) => from -> to -> ByteString -> ByteString data DynEncoding encodingFromString :: String -> DynEncoding encodingFromStringMaybe :: String -> Maybe DynEncoding

Documentation

class Encoding enc where Source

Represents an encoding, supporting various methods of de- and encoding. Minimal complete definition: encode, decode Methods encode :: enc -> String -> ByteString Source encodeLazy :: enc -> String -> ByteString Source encodable :: enc -> Char -> Bool Source decode :: enc -> ByteString -> String Source decodeLazy :: enc -> ByteString -> String Source decodable :: enc -> ByteString -> Bool Source Instances Encoding GB18030 Encoding KOI8U Encoding KOI8R Encoding CP1258 Encoding CP1257 Encoding CP1256 Encoding CP1255 Encoding CP1254 Encoding CP1253 Encoding CP1252 Encoding CP1251 Encoding CP1250 Encoding BootString Encoding ISO885916 Encoding ISO885915 Encoding ISO885914 Encoding ISO885913 Encoding ISO885911 Encoding ISO885910 Encoding ISO88599 Encoding ISO88598 Encoding ISO88597 Encoding ISO88596 Encoding ISO88595 Encoding ISO88594 Encoding ISO88593 Encoding ISO88592 Encoding ISO88591 Encoding UTF32 Encoding UTF16 Encoding UTF8 Encoding ASCII Encoding DynEncoding

data EncodingException Source

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 Source

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 Source

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

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

data DynEncoding Source

An untyped encoding. Used in System.IO.Encoding.getSystemEncoding. Instances Eq DynEncoding Show DynEncoding Encoding DynEncoding

encodingFromString :: String -> DynEncoding Source

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

encodingFromStringMaybe :: String -> Maybe DynEncoding Source

Like encodingFromString but returns Nothing instead of throwing an error

Produced by Haddock version 2.1.0