Data.MIME.Charset

MIME character sets.

Recognised charsets:

• us-ascii / iso646-us

• utf-8

• iso-8859-1

Documentation

class HasCharset a where

Associated Types

type Decoded a

Methods

charsetName :: Getter a (Maybe CharsetName)

Get the declared (or default) character set name. There is no guarantee that it corresponds to a registered or supported charset.

charsetData :: Getter a ByteString

Return the encoded data in the structure

charsetDecoded :: AsCharsetError e => CharsetLookup -> Getter a (Either e (Decoded a))

Structure with the encoded data replaced with Text

charsetEncode :: Decoded a -> a

Encode the data

Instances

HasCharset EncodedParameterValue

The default charset us-ascii is implied by the abstract of RFC 2231 which states: /This memo defines … a means to specify parameter values in character sets other than US-ASCII/.

When encoding, 'utf-8' is always used, but if the whole string contains only ASCII characters then the charset declaration is omitted (so that it can be encoded as a non-extended parameter).

Defined in Data.MIME.Parameter

Associated Types

type Decoded EncodedParameterValue :: Type

Methods

charsetName :: Getter EncodedParameterValue (Maybe CharsetName)

charsetData :: Getter EncodedParameterValue ByteString

charsetDecoded :: AsCharsetError e => CharsetLookup -> Getter EncodedParameterValue (Either e (Decoded EncodedParameterValue))

charsetEncode :: Decoded EncodedParameterValue -> EncodedParameterValue

HasCharset ByteEntity

RFC 2046 §4.1.2. defines the default character set to be US-ASCII.

Defined in Data.MIME

Associated Types

type Decoded ByteEntity :: Type

Methods

charsetName :: Getter ByteEntity (Maybe CharsetName)

charsetData :: Getter ByteEntity ByteString

charsetDecoded :: AsCharsetError e => CharsetLookup -> Getter ByteEntity (Either e (Decoded ByteEntity))

charsetEncode :: Decoded ByteEntity -> ByteEntity

type CharsetName = CI ByteString

charsetText :: (HasCharset a, AsCharsetError e) => CharsetLookup -> Getter a (Either e Text)

Decode the object according to the declared charset.

charsetText' :: HasCharset a => CharsetLookup -> Getter a (Either CharsetError Text)

Monomorphic in error type

data CharsetError

Constructors

CharsetUnspecified

CharsetUnsupported CharsetName

CharsetDecodeError CharsetName

Instances

Show CharsetError

Defined in Data.MIME.Charset

Methods

showsPrec :: Int -> CharsetError -> ShowS

show :: CharsetError -> String

showList :: [CharsetError] -> ShowS

AsCharsetError CharsetError

Defined in Data.MIME.Charset

Methods

_CharsetError :: Prism' CharsetError CharsetError

_CharsetUnspecified :: Prism' CharsetError ()

_CharsetUnsupported :: Prism' CharsetError CharsetName

_CharsetDecodeError :: Prism' CharsetError CharsetName

class AsCharsetError s where

Minimal complete definition

_CharsetError

Methods

_CharsetError :: Prism' s CharsetError

_CharsetUnspecified :: Prism' s ()

_CharsetUnsupported :: Prism' s CharsetName

_CharsetDecodeError :: Prism' s CharsetName

Instances

AsCharsetError CharsetError

Defined in Data.MIME.Charset

Methods

_CharsetError :: Prism' CharsetError CharsetError

_CharsetUnspecified :: Prism' CharsetError ()

_CharsetUnsupported :: Prism' CharsetError CharsetName

_CharsetDecodeError :: Prism' CharsetError CharsetName

AsCharsetError EncodingError

Defined in Data.MIME.Error

Methods

_CharsetError :: Prism' EncodingError CharsetError

_CharsetUnspecified :: Prism' EncodingError ()

_CharsetUnsupported :: Prism' EncodingError CharsetName

_CharsetDecodeError :: Prism' EncodingError CharsetName

charsetPrism :: forall a. HasCharset a => CharsetLookup -> Prism' a (Decoded a)

Prism for charset decoded/encoded data. Information about decoding failures is discarded.

type CharsetLookup = CI ByteString -> Maybe Charset

defaultCharsets :: CharsetLookup

Supports US-ASCII, UTF-8 and ISO-8859-1.

decodeLenient :: ByteString -> Text

Decode as UTF-8, replacing invalid sequences with placeholders.