Data.MIME.TransferEncoding

MIME content transfer encodings.

Documentation

class HasTransferEncoding a where

Data types that can have transfer encoding.

Minimal complete definition

transferEncodingName, transferEncodedData, transferDecoded, transferEncode

Associated Types

type TransferDecoded a

Methods

transferEncodingName :: Getter a TransferEncodingName

Get the declared or default transfer encoding name.

transferEncodedData :: Getter a ByteString

Return the encoded data in the structure.

transferDecoded :: (AsTransferEncodingError e, Profunctor p, Contravariant f) => Optic' p f a (Either e (TransferDecoded a))

Perform content transfer decoding.

transferDecoded' :: (Profunctor p, Contravariant f) => Optic' p f a (Either TransferEncodingError (TransferDecoded a))

Perform content transfer decoding (monomorphic error type).

transferEncode :: TransferDecoded a -> a

Encode the data

Instances

HasTransferEncoding WireEntity

Defined in Data.MIME

Associated Types

type TransferDecoded WireEntity

Methods

transferEncodingName :: Getter WireEntity TransferEncodingName

transferEncodedData :: Getter WireEntity ByteString

transferDecoded :: (AsTransferEncodingError e, Profunctor p, Contravariant f) => Optic' p f WireEntity (Either e (TransferDecoded WireEntity))

transferDecoded' :: (Profunctor p, Contravariant f) => Optic' p f WireEntity (Either TransferEncodingError (TransferDecoded WireEntity))

transferEncode :: TransferDecoded WireEntity -> WireEntity

HasTransferEncoding EncodedWord

Defined in Data.MIME.EncodedWord

Associated Types

type TransferDecoded EncodedWord

Methods

transferEncodingName :: Getter EncodedWord TransferEncodingName

transferEncodedData :: Getter EncodedWord ByteString

transferDecoded :: (AsTransferEncodingError e, Profunctor p, Contravariant f) => Optic' p f EncodedWord (Either e (TransferDecoded EncodedWord))

transferDecoded' :: (Profunctor p, Contravariant f) => Optic' p f EncodedWord (Either TransferEncodingError (TransferDecoded EncodedWord))

transferEncode :: TransferDecoded EncodedWord -> EncodedWord

type TransferEncodingName = CI ByteString

transferDecodedBytes :: (HasTransferEncoding a, AsTransferEncodingError e, Profunctor p, Contravariant f) => Optic' p f a (Either e ByteString)

Decode the object according to the declared content transfer encoding.

transferEncodings :: [(CI ByteString, TransferEncoding)]

Get the Content-Transfer-Encoding for an entity. Defaults to 7bit (RFC 2045 §6.1) if the header is not present. Fails on unrecognised values.

data TransferEncodingError

Constructors

TransferEncodingUnsupported TransferEncodingName

TransferDecodeError TransferEncodingName

Instances

Show TransferEncodingError

Defined in Data.MIME.TransferEncoding

Methods

showsPrec :: Int -> TransferEncodingError -> ShowS

show :: TransferEncodingError -> String

showList :: [TransferEncodingError] -> ShowS

AsTransferEncodingError TransferEncodingError

Defined in Data.MIME.TransferEncoding

Methods

_TransferEncodingError :: Prism' TransferEncodingError TransferEncodingError

_TransferEncodingUnsupported :: Prism' TransferEncodingError TransferEncodingName

_TransferDecodeError :: Prism' TransferEncodingError TransferEncodingName

class AsTransferEncodingError s where

Minimal complete definition

_TransferEncodingError

Methods

_TransferEncodingError :: Prism' s TransferEncodingError

_TransferEncodingUnsupported :: Prism' s TransferEncodingName

_TransferDecodeError :: Prism' s TransferEncodingName

Instances

AsTransferEncodingError EncodingError

Defined in Data.MIME.Error

Methods

_TransferEncodingError :: Prism' EncodingError TransferEncodingError

_TransferEncodingUnsupported :: Prism' EncodingError TransferEncodingName

_TransferDecodeError :: Prism' EncodingError TransferEncodingName

AsTransferEncodingError TransferEncodingError

Defined in Data.MIME.TransferEncoding

Methods

_TransferEncodingError :: Prism' TransferEncodingError TransferEncodingError

_TransferEncodingUnsupported :: Prism' TransferEncodingError TransferEncodingName

_TransferDecodeError :: Prism' TransferEncodingError TransferEncodingName

type TransferEncoding = APrism' ByteString ByteString

chooseTransferEncoding :: ByteString -> (TransferEncodingName, TransferEncoding)

Inspect the data and choose a transfer encoding to use: 7bit if the data can be transmitted as-is, otherwise whichever of quoted-printable or base64 should result in smaller output.