Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- newtype MessageHeadersIter = MessageHeadersIter (ManagedPtr MessageHeadersIter)
- newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter
- noMessageHeadersIter :: Maybe MessageHeadersIter
- messageHeadersIterInit :: (HasCallStack, MonadIO m) => MessageHeaders -> m MessageHeadersIter
- messageHeadersIterNext :: (HasCallStack, MonadIO m) => MessageHeadersIter -> m (Bool, Text, Text)
Exported types
newtype MessageHeadersIter Source #
WrappedPtr MessageHeadersIter Source # | |
(~) AttrOpTag tag AttrSet => Constructible MessageHeadersIter tag Source # | |
newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter Source #
Construct a MessageHeadersIter
struct initialized to zero.
Methods
init
messageHeadersIterInit Source #
:: (HasCallStack, MonadIO m) | |
=> MessageHeaders |
|
-> m MessageHeadersIter |
Initializes iter
for iterating hdrs
.
next
messageHeadersIterNext Source #
:: (HasCallStack, MonadIO m) | |
=> MessageHeadersIter |
|
-> m (Bool, Text, Text) | Returns: |
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.