| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Soup.Structs.MessageBody
Contents
Description
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).
- newtype MessageBody = MessageBody (ForeignPtr MessageBody)
- newZeroMessageBody :: MonadIO m => m MessageBody
- noMessageBody :: Maybe MessageBody
- data MessageBodyAppendMethodInfo
- messageBodyAppend :: MonadIO m => MessageBody -> ByteString -> m ()
- data MessageBodyAppendBufferMethodInfo
- messageBodyAppendBuffer :: MonadIO m => MessageBody -> Buffer -> m ()
- data MessageBodyCompleteMethodInfo
- messageBodyComplete :: MonadIO m => MessageBody -> m ()
- data MessageBodyFlattenMethodInfo
- messageBodyFlatten :: MonadIO m => MessageBody -> m Buffer
- data MessageBodyFreeMethodInfo
- messageBodyFree :: MonadIO m => MessageBody -> m ()
- data MessageBodyGetAccumulateMethodInfo
- messageBodyGetAccumulate :: MonadIO m => MessageBody -> m Bool
- data MessageBodyGetChunkMethodInfo
- messageBodyGetChunk :: MonadIO m => MessageBody -> Int64 -> m Buffer
- data MessageBodyGotChunkMethodInfo
- messageBodyGotChunk :: MonadIO m => MessageBody -> Buffer -> m ()
- messageBodyNew :: MonadIO m => m MessageBody
- data MessageBodySetAccumulateMethodInfo
- messageBodySetAccumulate :: MonadIO m => MessageBody -> Bool -> m ()
- data MessageBodyTruncateMethodInfo
- messageBodyTruncate :: MonadIO m => MessageBody -> m ()
- data MessageBodyWroteChunkMethodInfo
- messageBodyWroteChunk :: MonadIO m => MessageBody -> Buffer -> m ()
- messageBodyReadData :: MessageBody -> IO Text
- messageBodyReadLength :: MessageBody -> IO Int64
Exported types
newtype MessageBody Source
Constructors
| MessageBody (ForeignPtr MessageBody) |
Instances
newZeroMessageBody :: MonadIO m => m MessageBody Source
Construct a MessageBody struct initialized to zero.
Methods
messageBodyAppend
data MessageBodyAppendMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (ByteString -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyAppendMethodInfo MessageBody signature Source | |
messageBodyAppend :: MonadIO m => MessageBody -> ByteString -> m () Source
messageBodyAppendBuffer
data MessageBodyAppendBufferMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (Buffer -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyAppendBufferMethodInfo MessageBody signature Source | |
messageBodyAppendBuffer :: MonadIO m => MessageBody -> Buffer -> m () Source
messageBodyComplete
data MessageBodyCompleteMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyCompleteMethodInfo MessageBody signature Source | |
messageBodyComplete :: MonadIO m => MessageBody -> m () Source
messageBodyFlatten
data MessageBodyFlattenMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (m Buffer), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyFlattenMethodInfo MessageBody signature Source | |
messageBodyFlatten :: MonadIO m => MessageBody -> m Buffer Source
messageBodyFree
data MessageBodyFreeMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyFreeMethodInfo MessageBody signature Source | |
messageBodyFree :: MonadIO m => MessageBody -> m () Source
messageBodyGetAccumulate
data MessageBodyGetAccumulateMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyGetAccumulateMethodInfo MessageBody signature Source | |
messageBodyGetAccumulate :: MonadIO m => MessageBody -> m Bool Source
messageBodyGetChunk
data MessageBodyGetChunkMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (Int64 -> m Buffer), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyGetChunkMethodInfo MessageBody signature Source | |
messageBodyGetChunk :: MonadIO m => MessageBody -> Int64 -> m Buffer Source
messageBodyGotChunk
data MessageBodyGotChunkMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (Buffer -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyGotChunkMethodInfo MessageBody signature Source | |
messageBodyGotChunk :: MonadIO m => MessageBody -> Buffer -> m () Source
messageBodyNew
messageBodyNew :: MonadIO m => m MessageBody Source
messageBodySetAccumulate
data MessageBodySetAccumulateMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (Bool -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodySetAccumulateMethodInfo MessageBody signature Source | |
messageBodySetAccumulate :: MonadIO m => MessageBody -> Bool -> m () Source
messageBodyTruncate
data MessageBodyTruncateMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyTruncateMethodInfo MessageBody signature Source | |
messageBodyTruncate :: MonadIO m => MessageBody -> m () Source
messageBodyWroteChunk
data MessageBodyWroteChunkMethodInfo Source
Instances
| ((~) (TYPE Lifted) signature (Buffer -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MessageBodyWroteChunkMethodInfo MessageBody signature Source | |
messageBodyWroteChunk :: MonadIO m => MessageBody -> Buffer -> m () Source