cgi-2006.9.6 Contents Index

Network.CGI.Multipart Portability non-portable Stability experimental Maintainer bjorn@bringert.net

Contents Multi-part messages Headers

Description

Parsing of the multipart format from RFC2046. Partly based on code from WASHMail.

Synopsis

data MultiPart = MultiPart [BodyPart] data BodyPart = BodyPart [Header] ByteString type Header = (String, String) parseMultipartBody :: String -> ByteString -> Maybe MultiPart hGetMultipartBody :: String -> Handle -> IO MultiPart data ContentType = ContentType { ctType :: String ctSubtype :: String ctParamaters :: [(String, String)] } data ContentTransferEncoding = ContentTransferEncoding String data ContentDisposition = ContentDisposition String [(String, String)] parseContentType :: Monad m => String -> m ContentType parseContentTransferEncoding :: Monad m => String -> m ContentTransferEncoding parseContentDisposition :: Monad m => String -> m ContentDisposition getContentType :: Monad m => [Header] -> m ContentType getContentTransferEncoding :: Monad m => [Header] -> m ContentTransferEncoding getContentDisposition :: Monad m => [Header] -> m ContentDisposition

Multi-part messages

data MultiPart

Constructors MultiPart [BodyPart] Instances Eq MultiPart Ord MultiPart Read MultiPart Show MultiPart

data BodyPart

Constructors BodyPart [Header] ByteString Instances Eq BodyPart Ord BodyPart Read BodyPart Show BodyPart

type Header = (String, String)

parseMultipartBody

:: String Boundary -> ByteString -> Maybe MultiPart Read a multi-part message from a ByteString.

hGetMultipartBody

:: String Boundary -> Handle -> IO MultiPart Read a multi-part message from a Handle. Fails on parse errors.

Headers

data ContentType

A MIME media type value. The Show instance is derived automatically. Use showContentType to obtain the standard string representation. See http://www.ietf.org/rfc/rfc2046.txt for more information about MIME media types. Constructors ContentType ctType :: String The top-level media type, the general type of the data. Common examples are "text", "image", "audio", "video", "multipart", and "application". ctSubtype :: String The media subtype, the specific data format. Examples include "plain", "html", "jpeg", "form-data", etc. ctParamaters :: [(String, String)] Media type parameters. On common example is the charset parameter for the "text" top-level type, e.g. ("charset","ISO-8859-1"). Instances Eq ContentType Ord ContentType Read ContentType Show ContentType

data ContentTransferEncoding

Constructors ContentTransferEncoding String Instances Eq ContentTransferEncoding Ord ContentTransferEncoding Read ContentTransferEncoding Show ContentTransferEncoding

data ContentDisposition

Constructors ContentDisposition String [(String, String)] Instances Eq ContentDisposition Ord ContentDisposition Read ContentDisposition Show ContentDisposition

parseContentType :: Monad m => String -> m ContentType

Parse the standard representation of a content-type. If the input cannot be parsed, this function calls fail with a (hopefully) informative error message.

parseContentTransferEncoding :: Monad m => String -> m ContentTransferEncoding

parseContentDisposition :: Monad m => String -> m ContentDisposition

getContentType :: Monad m => [Header] -> m ContentType

getContentTransferEncoding :: Monad m => [Header] -> m ContentTransferEncoding

getContentDisposition :: Monad m => [Header] -> m ContentDisposition

Produced by Haddock version 0.7