gi-soup-3.0.3: Libsoup bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Soup.Structs.MessageHeadersIter

Description

An opaque type used to iterate over a SoupMessageHeaders structure.

After intializing the iterator with MessageHeadersIter.init, call [methodmessageHeadersIter.next] to fetch data from it.

You may not modify the headers while iterating over them.

Synopsis

Exported types

newtype MessageHeadersIter Source #

Memory-managed wrapper type.

Constructors

MessageHeadersIter (ManagedPtr MessageHeadersIter) 

newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter Source #

Construct a MessageHeadersIter struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

next.

Getters

None.

Setters

None.

init

messageHeadersIterInit Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MessageHeaders

hdrs: a SoupMessageHeaders

-> m MessageHeadersIter 

Initializes iter for iterating hdrs.

next

messageHeadersIterNext Source #

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 [structmessageHeaders] being iterated by iter.

If iter has already yielded the last header, then [methodmessageHeadersIter.next] will return False and name and value will be unchanged.