encoding-0.6.2: A library for various character encodings Source code Contents Index

Data.Encoding

Synopsis

module Data.Encoding.Exception module Data.Encoding.ByteSource module Data.Encoding.ByteSink class Encoding enc where decodeChar :: ByteSource m => enc -> m Char encodeChar :: ByteSink m => enc -> Char -> m () decode :: ByteSource m => enc -> m String encode :: ByteSink m => enc -> String -> m () encodeable :: enc -> Char -> Bool data DynEncoding 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 encodingFromStringExplicit :: String -> Maybe DynEncoding

Documentation

module Data.Encoding.Exception

module Data.Encoding.ByteSource

module Data.Encoding.ByteSink

class Encoding enc where Source

The base class for all encodings. At least decodeChar, encodeChar and encodeable must be implemented. Methods decodeChar :: ByteSource m => enc -> m Char Source Read a single character of a ByteSource encodeChar :: ByteSink m => enc -> Char -> m () Source Encode a single character and write it to a ByteSink decode :: ByteSource m => enc -> m String Source Read characters from a ByteSource until it is empty encode :: ByteSink m => enc -> String -> m () Source Encode a String and write it to a ByteSink encodeable :: enc -> Char -> Bool Source 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 Encoding ASCII Encoding UTF8 Encoding UTF16 Encoding UTF32 Encoding ISO88591 Encoding KOI8R Encoding KOI8U 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 GB18030 Encoding MacOSRoman Encoding JISX0201 Encoding JISX0208 Encoding CP437 Encoding CP737 Encoding CP775 Encoding CP850 Encoding CP852 Encoding CP855 Encoding CP857 Encoding CP860 Encoding CP861 Encoding CP862 Encoding CP863 Encoding CP864 Encoding CP865 Encoding CP866 Encoding CP869 Encoding CP874 Encoding BootString Encoding JISX0212 Encoding ISO2022JP

data DynEncoding Source

Wraps all possible encoding types into one data type. Used when a function needs to return an encoding. Instances Eq DynEncoding Show DynEncoding Encoding DynEncoding

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

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

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

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

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

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

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

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

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

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

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

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

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

encodingFromString :: String -> DynEncoding Source

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

encodingFromStringExplicit :: String -> Maybe DynEncoding Source

Like encodingFromString but returns Nothing instead of throwing an error

Produced by Haddock version 2.6.0