Soup.MessageHeadersIter

Fields

Name	Type	Access	Description
dummy	[object]	r

Methods

class	init (hdrs)
class	next (iter)

Details

class Soup.MessageHeadersIter

An opaque type used to iterate over a Soup.MessageHeaders structure.

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

You may not modify the headers while iterating over them.

classmethod init(hdrs)

Parameters:

hdrs (Soup.MessageHeaders) – a Soup.MessageHeaders

Returns:

a pointer to a Soup.MessageHeadersIter structure

Return type:

iter: Soup.MessageHeadersIter

Initializes iter for iterating hdrs.

classmethod next(iter)

Parameters:

iter (Soup.MessageHeadersIter) – a Soup.MessageHeadersIter

Returns:

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

iter:

a Soup.MessageHeadersIter

name:

pointer to a variable to return the header name in

value:

pointer to a variable to return the header value in

Return type:

(bool, iter: Soup.MessageHeadersIter, name: str, value: str)

Yields the next name/value pair in the [struct`MessageHeaders`] being iterated by iter.

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