Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Soup.Structs.Multipart

Contents

Exported types
Methods

Description

Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046.

Of particular interest to HTTP are multipart/byte-ranges and multipart/form-data,

Although the headers of a Multipart body part will contain the full headers from that body part, libsoup does not interpret them according to MIME rules. For example, each body part is assumed to have "binary" Content-Transfer-Encoding, even if its headers explicitly state otherwise. In other words, don't try to use Multipart for handling real MIME multiparts.

Synopsis

newtype Multipart = Multipart (ManagedPtr Multipart)
type family ResolveMultipartMethod (t :: Symbol) o where ...
data MultipartAppendFormFileMethodInfo
multipartAppendFormFile :: (HasCallStack, MonadIO m) => Multipart -> Text -> Maybe Text -> Maybe Text -> Bytes -> m ()
data MultipartAppendFormStringMethodInfo
multipartAppendFormString :: (HasCallStack, MonadIO m) => Multipart -> Text -> Text -> m ()
data MultipartAppendPartMethodInfo
multipartAppendPart :: (HasCallStack, MonadIO m) => Multipart -> MessageHeaders -> Bytes -> m ()
data MultipartFreeMethodInfo
multipartFree :: (HasCallStack, MonadIO m) => Multipart -> m ()
data MultipartGetLengthMethodInfo
multipartGetLength :: (HasCallStack, MonadIO m) => Multipart -> m Int32
data MultipartGetPartMethodInfo
multipartGetPart :: (HasCallStack, MonadIO m) => Multipart -> Int32 -> m (Bool, MessageHeaders, Bytes)
multipartNew :: (HasCallStack, MonadIO m) => Text -> m Multipart
multipartNewFromMessage :: (HasCallStack, MonadIO m) => MessageHeaders -> Bytes -> m (Maybe Multipart)
data MultipartToMessageMethodInfo
multipartToMessage :: (HasCallStack, MonadIO m) => Multipart -> MessageHeaders -> m Bytes

Exported types

newtype Multipart Source #

Memory-managed wrapper type.

Constructors

Multipart (ManagedPtr Multipart)

Instances

Instances details

Eq Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods (==) :: Multipart -> Multipart -> Bool # (/=) :: Multipart -> Multipart -> Bool #
GBoxed Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart
ManagedPtrNewtype Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods toManagedPtr :: Multipart -> ManagedPtr Multipart #
TypedObject Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods glibType :: IO GType #
HasParentTypes Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart
HasAttributeList Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart
(signature ~ (Text -> Maybe Text -> Maybe Text -> Bytes -> m ()), MonadIO m) => OverloadedMethod MultipartAppendFormFileMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod MultipartAppendFormStringMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ (MessageHeaders -> Bytes -> m ()), MonadIO m) => OverloadedMethod MultipartAppendPartMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ m (), MonadIO m) => OverloadedMethod MultipartFreeMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ m Int32, MonadIO m) => OverloadedMethod MultipartGetLengthMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ (Int32 -> m (Bool, MessageHeaders, Bytes)), MonadIO m) => OverloadedMethod MultipartGetPartMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
(signature ~ (MessageHeaders -> m Bytes), MonadIO m) => OverloadedMethod MultipartToMessageMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartAppendFormFileMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartAppendFormStringMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartAppendPartMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartFreeMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartGetLengthMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartGetPartMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
OverloadedMethodInfo MultipartToMessageMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
(info ~ ResolveMultipartMethod t Multipart, OverloadedMethod info Multipart p, HasField t Multipart p) => HasField (t :: Symbol) Multipart (p :: Type) Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods getField :: Multipart -> p #
(info ~ ResolveMultipartMethod t Multipart, OverloadedMethodInfo info Multipart) => IsLabel t (MethodProxy info Multipart) Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods fromLabel :: MethodProxy info Multipart #
(info ~ ResolveMultipartMethod t Multipart, OverloadedMethod info Multipart p) => IsLabel t (Multipart -> p) Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods fromLabel :: Multipart -> p #
IsGValue (Maybe Multipart) Source #	Convert `Multipart` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Soup.Structs.Multipart Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Multipart -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Multipart) #
type AttributeList Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart type AttributeList Multipart
type ParentTypes Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart type ParentTypes Multipart = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

appendFormFile, appendFormString, appendPart, free, toMessage.

Getters

getLength, getPart.

Setters

None.

type family ResolveMultipartMethod (t :: Symbol) o where ... Source #

Equations

ResolveMultipartMethod "appendFormFile" o = MultipartAppendFormFileMethodInfo
ResolveMultipartMethod "appendFormString" o = MultipartAppendFormStringMethodInfo
ResolveMultipartMethod "appendPart" o = MultipartAppendPartMethodInfo
ResolveMultipartMethod "free" o = MultipartFreeMethodInfo
ResolveMultipartMethod "toMessage" o = MultipartToMessageMethodInfo
ResolveMultipartMethod "getLength" o = MultipartGetLengthMethodInfo
ResolveMultipartMethod "getPart" o = MultipartGetPartMethodInfo
ResolveMultipartMethod l o = MethodResolutionFailed l o :: Type

appendFormFile

data MultipartAppendFormFileMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Maybe Text -> Maybe Text -> Bytes -> m ()), MonadIO m) => OverloadedMethod MultipartAppendFormFileMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartAppendFormFileMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartAppendFormFile Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a multipart (presumably of type "multipart/form-data")
-> Text	`controlName`: the name of the control associated with this file
-> Maybe Text	`filename`: the name of the file, or `Nothing` if not known
-> Maybe Text	`contentType`: the MIME type of the file, or `Nothing` if not known
-> Bytes	`body`: the file data
-> m ()

Adds a new MIME part containing body to multipart

Uses "Content-Disposition: form-data", as per the HTML forms specification.

appendFormString

data MultipartAppendFormStringMethodInfo Source #

Instances

Instances details

(signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod MultipartAppendFormStringMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartAppendFormStringMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartAppendFormString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a multipart (presumably of type "multipart/form-data")
-> Text	`controlName`: the name of the control associated with `data`
-> Text	`data`: the body data
-> m ()

Adds a new MIME part containing data to multipart.

Uses "Content-Disposition: form-data", as per the HTML forms specification.

appendPart

data MultipartAppendPartMethodInfo Source #

Instances

Instances details

(signature ~ (MessageHeaders -> Bytes -> m ()), MonadIO m) => OverloadedMethod MultipartAppendPartMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartAppendPartMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartAppendPart Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a `Multipart`
-> MessageHeaders	`headers`: the MIME part headers
-> Bytes	`body`: the MIME part body
-> m ()

Adds a new MIME part to multipart with the given headers and body.

(The multipart will make its own copies of headers and body, so you should free your copies if you are not using them for anything else.)

free

data MultipartFreeMethodInfo Source #

Instances

Instances details

(signature ~ m (), MonadIO m) => OverloadedMethod MultipartFreeMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartFreeMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a `Multipart`
-> m ()

Frees multipart.

getLength

data MultipartGetLengthMethodInfo Source #

Instances

Instances details

(signature ~ m Int32, MonadIO m) => OverloadedMethod MultipartGetLengthMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartGetLengthMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartGetLength Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a `Multipart`
-> m Int32	Returns: the number of body parts in `multipart`

Gets the number of body parts in multipart.

getPart

data MultipartGetPartMethodInfo Source #

Instances

Instances details

(signature ~ (Int32 -> m (Bool, MessageHeaders, Bytes)), MonadIO m) => OverloadedMethod MultipartGetPartMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartGetPartMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartGetPart Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a `Multipart`
-> Int32	`part`: the part number to get (counting from 0)
-> m (Bool, MessageHeaders, Bytes)	Returns: `True` on success, `False` if `part` is out of range (in which case `headers` and `body` won't be set)

Gets the indicated body part from multipart.

new

multipartNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`mimeType`: the MIME type of the multipart to create.
-> m Multipart	Returns: a new empty `Multipart` of the given `mimeType`

Creates a new empty Multipart with a randomly-generated boundary string.

Note that mimeType must be the full MIME type, including "multipart/".

See also: [ctormessage.new_from_multipart].

newFromMessage

multipartNewFromMessage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> MessageHeaders	`headers`: the headers of the HTTP message to parse
-> Bytes	`body`: the body of the HTTP message to parse
-> m (Maybe Multipart)	Returns: a new `Multipart` (or `Nothing` if the message couldn't be parsed or wasn't multipart).

Parses headers and body to form a new Multipart

toMessage

data MultipartToMessageMethodInfo Source #

Instances

Instances details

(signature ~ (MessageHeaders -> m Bytes), MonadIO m) => OverloadedMethod MultipartToMessageMethodInfo Multipart signature Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethod :: Multipart -> signature #
OverloadedMethodInfo MultipartToMessageMethodInfo Multipart Source #
Instance details Defined in GI.Soup.Structs.Multipart Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

multipartToMessage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Multipart	`multipart`: a `Multipart`
-> MessageHeaders	`destHeaders`: the headers of the HTTP message to serialize `multipart` to
-> m Bytes

Serializes multipart to destHeaders and destBody.