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

Memory-managed wrapper type.

Constructors

MessageHeadersIter (ManagedPtr MessageHeadersIter)

Instances

Eq MessageHeadersIter

Defined in GI.Soup.Structs.MessageHeadersIter

Methods

(==) :: MessageHeadersIter -> MessageHeadersIter -> Bool

(/=) :: MessageHeadersIter -> MessageHeadersIter -> Bool

BoxedPtr MessageHeadersIter

Defined in GI.Soup.Structs.MessageHeadersIter

Methods

boxedPtrCopy :: MessageHeadersIter -> IO MessageHeadersIter

boxedPtrFree :: MessageHeadersIter -> IO ()

CallocPtr MessageHeadersIter

Defined in GI.Soup.Structs.MessageHeadersIter

Methods

boxedPtrCalloc :: IO (Ptr MessageHeadersIter)

ManagedPtrNewtype MessageHeadersIter

Defined in GI.Soup.Structs.MessageHeadersIter

Methods

toManagedPtr :: MessageHeadersIter -> ManagedPtr MessageHeadersIter

tag ~ 'AttrSet => Constructible MessageHeadersIter tag

Defined in GI.Soup.Structs.MessageHeadersIter

Methods

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

newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter

Construct a MessageHeadersIter struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

next.

Getters

None.

Setters

None.

init

messageHeadersIterInit

Arguments

:: (HasCallStack, MonadIO m)

=> MessageHeaders

hdrs: a SoupMessageHeaders

-> m MessageHeadersIter

Initializes iter for iterating hdrs.

next

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.