GI.Soup.Objects.MultipartInputStream

Exported types

newtype MultipartInputStream

Constructors

MultipartInputStream (ManagedPtr MultipartInputStream)

Instances

GObject MultipartInputStream

Methods

gobjectType :: MultipartInputStream -> IO GType

IsPollableInputStream MultipartInputStream

IsFilterInputStream MultipartInputStream

IsInputStream MultipartInputStream

IsObject MultipartInputStream

IsMultipartInputStream MultipartInputStream

((~) * info (ResolveMultipartInputStreamMethod t MultipartInputStream), MethodInfo * info MultipartInputStream p) => IsLabel t (MultipartInputStream -> p)

Methods

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

((~) * info (ResolveMultipartInputStreamMethod t MultipartInputStream), MethodInfo * info MultipartInputStream p) => IsLabelProxy t (MultipartInputStream -> p)

Methods

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

HasAttributeList * MultipartInputStream

type AttributeList MultipartInputStream

type AttributeList MultipartInputStream

type SignalList MultipartInputStream

type SignalList MultipartInputStream

class GObject o => IsMultipartInputStream o

Instances

(GObject a, UnknownAncestorError Constraint MultipartInputStream a) => IsMultipartInputStream a

IsMultipartInputStream MultipartInputStream

toMultipartInputStream :: IsMultipartInputStream o => o -> IO MultipartInputStream

noMultipartInputStream :: Maybe MultipartInputStream

Methods

getHeaders

data MultipartInputStreamGetHeadersMethodInfo

Instances

((~) * signature (m (Maybe MessageHeaders)), MonadIO m, IsMultipartInputStream a) => MethodInfo * MultipartInputStreamGetHeadersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MultipartInputStreamGetHeadersMethodInfo a -> signature -> s

multipartInputStreamGetHeaders

Arguments

:: (HasCallStack, MonadIO m, IsMultipartInputStream a)

=> a

multipart: a MultipartInputStream.

-> m (Maybe MessageHeaders)

Returns: a MessageHeaders containing the headers for the part currently being processed or Nothing if the headers failed to parse.

Obtains the headers for the part currently being processed. Note that the MessageHeaders that are returned are owned by the MultipartInputStream and will be replaced when a call is made to multipartInputStreamNextPart or its async counterpart, so if keeping the headers is required, a copy must be made.

Note that if a part had no headers at all an empty MessageHeaders will be returned.

Since: 2.40

new

multipartInputStreamNew

Arguments

:: (HasCallStack, MonadIO m, IsMessage a, IsInputStream b)

=> a

msg: the Message the response is related to.

-> b

baseStream: the InputStream returned by sending the request.

-> m MultipartInputStream

Returns: a new MultipartInputStream

Creates a new MultipartInputStream that wraps the InputStream obtained by sending the Request. Reads should not be done directly through this object, use the input streams returned by multipartInputStreamNextPart or its async counterpart instead.

Since: 2.40

nextPart

data MultipartInputStreamNextPartMethodInfo

Instances

((~) * signature (Maybe b -> m (Maybe InputStream)), MonadIO m, IsMultipartInputStream a, IsCancellable b) => MethodInfo * MultipartInputStreamNextPartMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MultipartInputStreamNextPartMethodInfo a -> signature -> s

multipartInputStreamNextPart

Arguments

:: (HasCallStack, MonadIO m, IsMultipartInputStream a, IsCancellable b)

=> a

multipart: the MultipartInputStream

-> Maybe b

cancellable: a Cancellable

-> m (Maybe InputStream)

Returns: a new InputStream, or Nothing if there are no more parts (Can throw GError)

Obtains an input stream for the next part. When dealing with a multipart response the input stream needs to be wrapped in a MultipartInputStream and this function or its async counterpart need to be called to obtain the first part for reading.

After calling this function, multipartInputStreamGetHeaders can be used to obtain the headers for the first part. A read of 0 bytes indicates the end of the part; a new call to this function should be done at that point, to obtain the next part.

Since: 2.40

nextPartAsync

data MultipartInputStreamNextPartAsyncMethodInfo

Instances

((~) * signature (Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsMultipartInputStream a, IsCancellable b) => MethodInfo * MultipartInputStreamNextPartAsyncMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MultipartInputStreamNextPartAsyncMethodInfo a -> signature -> s

multipartInputStreamNextPartAsync

Arguments

:: (HasCallStack, MonadIO m, IsMultipartInputStream a, IsCancellable b)

=> a

multipart: the MultipartInputStream.

-> Int32

ioPriority: the I/O priority for the request.

-> Maybe b

cancellable: a Cancellable.

-> Maybe AsyncReadyCallback

callback: callback to call when request is satisfied.

-> m ()

Obtains a InputStream for the next request. See multipartInputStreamNextPart for details on the workflow.

Since: 2.40

nextPartFinish

data MultipartInputStreamNextPartFinishMethodInfo

Instances

((~) * signature (b -> m (Maybe InputStream)), MonadIO m, IsMultipartInputStream a, IsAsyncResult b) => MethodInfo * MultipartInputStreamNextPartFinishMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MultipartInputStreamNextPartFinishMethodInfo a -> signature -> s

multipartInputStreamNextPartFinish

Arguments

:: (HasCallStack, MonadIO m, IsMultipartInputStream a, IsAsyncResult b)

=> a

multipart: a MultipartInputStream.

-> b

result: a AsyncResult.

-> m (Maybe InputStream)

Returns: a newly created InputStream for reading the next part or Nothing if there are no more parts. (Can throw GError)

Finishes an asynchronous request for the next part.

Since: 2.40

Properties

message

data MultipartInputStreamMessagePropertyInfo

Instances

AttrInfo MultipartInputStreamMessagePropertyInfo

Associated Types

type AttrAllowedOps MultipartInputStreamMessagePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint MultipartInputStreamMessagePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo :: * -> Constraint

type AttrGetType MultipartInputStreamMessagePropertyInfo :: *

type AttrLabel MultipartInputStreamMessagePropertyInfo :: Symbol

type AttrOrigin MultipartInputStreamMessagePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo o => Proxy * MultipartInputStreamMessagePropertyInfo -> o -> IO (AttrGetType MultipartInputStreamMessagePropertyInfo)

attrSet :: (AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo o, AttrSetTypeConstraint MultipartInputStreamMessagePropertyInfo b) => Proxy * MultipartInputStreamMessagePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo o => Proxy * MultipartInputStreamMessagePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo o, AttrSetTypeConstraint MultipartInputStreamMessagePropertyInfo b) => Proxy * MultipartInputStreamMessagePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin MultipartInputStreamMessagePropertyInfo

type AttrOrigin MultipartInputStreamMessagePropertyInfo = MultipartInputStream

type AttrLabel MultipartInputStreamMessagePropertyInfo

type AttrLabel MultipartInputStreamMessagePropertyInfo = "message"

type AttrGetType MultipartInputStreamMessagePropertyInfo

type AttrGetType MultipartInputStreamMessagePropertyInfo = Maybe Message

type AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo

type AttrBaseTypeConstraint MultipartInputStreamMessagePropertyInfo = IsMultipartInputStream

type AttrSetTypeConstraint MultipartInputStreamMessagePropertyInfo

type AttrSetTypeConstraint MultipartInputStreamMessagePropertyInfo = IsMessage

type AttrAllowedOps MultipartInputStreamMessagePropertyInfo

type AttrAllowedOps MultipartInputStreamMessagePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructMultipartInputStreamMessage :: (IsMultipartInputStream o, IsMessage a) => a -> IO (GValueConstruct o)

getMultipartInputStreamMessage :: (MonadIO m, IsMultipartInputStream o) => o -> m (Maybe Message)

multipartInputStreamMessage :: AttrLabelProxy "message"