GI.Soup.Structs.MessageBody

A #SoupMessage request or response body.

Note that while length always reflects the full length of the message body, data is normally %NULL, and will only be filled in after soup_message_body_flatten() is called. For client-side messages, this automatically happens for the response body after it has been fully read, unless you set the %SOUP_MESSAGE_OVERWRITE_CHUNKS flags. Likewise, for server-side messages, the request body is automatically filled in after being read.

As an added bonus, when data is filled in, it is always terminated with a '\0' byte (which is not reflected in length).

Exported types

newtype MessageBody

Constructors

MessageBody (ManagedPtr MessageBody)

Instances

BoxedObject MessageBody

Methods

boxedType :: MessageBody -> IO GType

(~) AttrOpTag tag AttrSet => Constructible MessageBody tag

Methods

new :: MonadIO m => (ManagedPtr MessageBody -> MessageBody) -> [AttrOp MessageBody tag] -> m MessageBody

((~) * info (ResolveMessageBodyMethod t MessageBody), MethodInfo * info MessageBody p) => IsLabel t (MessageBody -> p)

Methods

fromLabel :: Proxy# Symbol t -> MessageBody -> p

((~) * info (ResolveMessageBodyMethod t MessageBody), MethodInfo * info MessageBody p) => IsLabelProxy t (MessageBody -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> MessageBody -> p

HasAttributeList * MessageBody

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyWroteChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyWroteChunkMethodInfo MessageBody -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyTruncateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyTruncateMethodInfo MessageBody -> signature -> s

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * MessageBodySetAccumulateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodySetAccumulateMethodInfo MessageBody -> signature -> s

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyGotChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGotChunkMethodInfo MessageBody -> signature -> s

((~) * signature (Int64 -> m (Maybe Buffer)), MonadIO m) => MethodInfo * MessageBodyGetChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGetChunkMethodInfo MessageBody -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * MessageBodyGetAccumulateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGetAccumulateMethodInfo MessageBody -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyFreeMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyFreeMethodInfo MessageBody -> signature -> s

((~) * signature (m Buffer), MonadIO m) => MethodInfo * MessageBodyFlattenMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyFlattenMethodInfo MessageBody -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyCompleteMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyCompleteMethodInfo MessageBody -> signature -> s

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * MessageBodyAppendMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyAppendMethodInfo MessageBody -> signature -> s

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyAppendBufferMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyAppendBufferMethodInfo MessageBody -> signature -> s

type AttributeList MessageBody

type AttributeList MessageBody

newZeroMessageBody :: MonadIO m => m MessageBody

Construct a MessageBody struct initialized to zero.

noMessageBody :: Maybe MessageBody

Methods

append

data MessageBodyAppendMethodInfo

Instances

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * MessageBodyAppendMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyAppendMethodInfo MessageBody -> signature -> s

messageBodyAppend :: MonadIO m => MessageBody -> ByteString -> m ()

appendBuffer

data MessageBodyAppendBufferMethodInfo

Instances

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyAppendBufferMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyAppendBufferMethodInfo MessageBody -> signature -> s

messageBodyAppendBuffer :: MonadIO m => MessageBody -> Buffer -> m ()

complete

data MessageBodyCompleteMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyCompleteMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyCompleteMethodInfo MessageBody -> signature -> s

messageBodyComplete :: MonadIO m => MessageBody -> m ()

flatten

data MessageBodyFlattenMethodInfo

Instances

((~) * signature (m Buffer), MonadIO m) => MethodInfo * MessageBodyFlattenMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyFlattenMethodInfo MessageBody -> signature -> s

messageBodyFlatten :: MonadIO m => MessageBody -> m Buffer

free

data MessageBodyFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyFreeMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyFreeMethodInfo MessageBody -> signature -> s

messageBodyFree :: MonadIO m => MessageBody -> m ()

getAccumulate

data MessageBodyGetAccumulateMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * MessageBodyGetAccumulateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGetAccumulateMethodInfo MessageBody -> signature -> s

messageBodyGetAccumulate :: MonadIO m => MessageBody -> m Bool

getChunk

data MessageBodyGetChunkMethodInfo

Instances

((~) * signature (Int64 -> m (Maybe Buffer)), MonadIO m) => MethodInfo * MessageBodyGetChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGetChunkMethodInfo MessageBody -> signature -> s

messageBodyGetChunk :: MonadIO m => MessageBody -> Int64 -> m (Maybe Buffer)

gotChunk

data MessageBodyGotChunkMethodInfo

Instances

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyGotChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyGotChunkMethodInfo MessageBody -> signature -> s

messageBodyGotChunk :: MonadIO m => MessageBody -> Buffer -> m ()

new

messageBodyNew :: MonadIO m => m MessageBody

setAccumulate

data MessageBodySetAccumulateMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * MessageBodySetAccumulateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodySetAccumulateMethodInfo MessageBody -> signature -> s

messageBodySetAccumulate :: MonadIO m => MessageBody -> Bool -> m ()

truncate

data MessageBodyTruncateMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * MessageBodyTruncateMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyTruncateMethodInfo MessageBody -> signature -> s

messageBodyTruncate :: MonadIO m => MessageBody -> m ()

wroteChunk

data MessageBodyWroteChunkMethodInfo

Instances

((~) * signature (Buffer -> m ()), MonadIO m) => MethodInfo * MessageBodyWroteChunkMethodInfo MessageBody signature

Methods

overloadedMethod :: MethodProxy MessageBodyWroteChunkMethodInfo MessageBody -> signature -> s

messageBodyWroteChunk :: MonadIO m => MessageBody -> Buffer -> m ()

Properties

data

clearMessageBodyData :: MonadIO m => MessageBody -> m ()

getMessageBodyData :: MonadIO m => MessageBody -> m (Maybe Text)

messageBody_data :: AttrLabelProxy "data"

setMessageBodyData :: MonadIO m => MessageBody -> CString -> m ()

length

getMessageBodyLength :: MonadIO m => MessageBody -> m Int64

messageBody_length :: AttrLabelProxy "length"

setMessageBodyLength :: MonadIO m => MessageBody -> Int64 -> m ()