GI.Soup.Structs.MessageHeadersIter

An opaque type used to iterate over a SoupMessageHeaders structure.

After intializing the iterator with messageHeadersIterInit, call messageHeadersIterNext to fetch data from it.

You may not modify the headers while iterating over them.

Exported types

newtype MessageHeadersIter

Constructors

MessageHeadersIter (ManagedPtr MessageHeadersIter)

Instances

WrappedPtr MessageHeadersIter

Methods

wrappedPtrCalloc :: IO (Ptr MessageHeadersIter)

wrappedPtrCopy :: MessageHeadersIter -> IO MessageHeadersIter

wrappedPtrFree :: Maybe (FunPtr (Ptr MessageHeadersIter -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible MessageHeadersIter tag

Methods

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

((~) * info (ResolveMessageHeadersIterMethod t MessageHeadersIter), MethodInfo * info MessageHeadersIter p) => IsLabel t (MessageHeadersIter -> p)

Methods

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

((~) * info (ResolveMessageHeadersIterMethod t MessageHeadersIter), MethodInfo * info MessageHeadersIter p) => IsLabelProxy t (MessageHeadersIter -> p)

Methods

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

HasAttributeList * MessageHeadersIter

((~) * signature (m (Bool, Text, Text)), MonadIO m) => MethodInfo * MessageHeadersIterNextMethodInfo MessageHeadersIter signature

Methods

overloadedMethod :: MethodProxy MessageHeadersIterNextMethodInfo MessageHeadersIter -> signature -> s

type AttributeList MessageHeadersIter

type AttributeList MessageHeadersIter

newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter

Construct a MessageHeadersIter struct initialized to zero.

noMessageHeadersIter :: Maybe MessageHeadersIter

Methods

init

messageHeadersIterInit

Arguments

:: (HasCallStack, MonadIO m)

=> MessageHeaders

hdrs: a SoupMessageHeaders

-> m MessageHeadersIter

Initializes iter for iterating hdrs.

next

data MessageHeadersIterNextMethodInfo

Instances

((~) * signature (m (Bool, Text, Text)), MonadIO m) => MethodInfo * MessageHeadersIterNextMethodInfo MessageHeadersIter signature

Methods

overloadedMethod :: MethodProxy MessageHeadersIterNextMethodInfo MessageHeadersIter -> signature -> s

messageHeadersIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> MessageHeadersIter

iter: a SoupMessageHeadersIter

-> m (Bool, Text, Text)

Returns: True if another name and value were returned, False if the end of the headers has been reached.

Yields the next name/value pair in the SoupMessageHeaders being iterated by iter. If iter has already yielded the last header, then messageHeadersIterNext will return False and name and value will be unchanged.