Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Soup.Structs.MessageHeadersIter

Contents

Exported types
Methods
- init
- next

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

newtype MessageHeadersIter = MessageHeadersIter (ManagedPtr MessageHeadersIter)
newZeroMessageHeadersIter :: MonadIO m => m MessageHeadersIter
type family ResolveMessageHeadersIterMethod (t :: Symbol) o where ...
messageHeadersIterInit :: (HasCallStack, MonadIO m) => MessageHeaders -> m MessageHeadersIter
data MessageHeadersIterNextMethodInfo
messageHeadersIterNext :: (HasCallStack, MonadIO m) => MessageHeadersIter -> m (Bool, Text, Text)

Exported types

newtype MessageHeadersIter Source #

Memory-managed wrapper type.

Constructors

MessageHeadersIter (ManagedPtr MessageHeadersIter)

Instances

Instances details

Eq MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods (==) :: MessageHeadersIter -> MessageHeadersIter -> Bool # (/=) :: MessageHeadersIter -> MessageHeadersIter -> Bool #
BoxedPtr MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods boxedPtrCopy :: MessageHeadersIter -> IO MessageHeadersIter # boxedPtrFree :: MessageHeadersIter -> IO () #
CallocPtr MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods boxedPtrCalloc :: IO (Ptr MessageHeadersIter) #
ManagedPtrNewtype MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods toManagedPtr :: MessageHeadersIter -> ManagedPtr MessageHeadersIter #
tag ~ 'AttrSet => Constructible MessageHeadersIter tag Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods new :: MonadIO m => (ManagedPtr MessageHeadersIter -> MessageHeadersIter) -> [AttrOp MessageHeadersIter tag] -> m MessageHeadersIter #
HasAttributeList MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter
(signature ~ m (Bool, Text, Text), MonadIO m) => OverloadedMethod MessageHeadersIterNextMethodInfo MessageHeadersIter signature Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods overloadedMethod :: MessageHeadersIter -> signature #
OverloadedMethodInfo MessageHeadersIterNextMethodInfo MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #
(info ~ ResolveMessageHeadersIterMethod t MessageHeadersIter, OverloadedMethod info MessageHeadersIter p, HasField t MessageHeadersIter p) => HasField (t :: Symbol) MessageHeadersIter (p :: Type) Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods getField :: MessageHeadersIter -> p #
(info ~ ResolveMessageHeadersIterMethod t MessageHeadersIter, OverloadedMethodInfo info MessageHeadersIter) => IsLabel t (MethodProxy info MessageHeadersIter) Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods fromLabel :: MethodProxy info MessageHeadersIter #
(info ~ ResolveMessageHeadersIterMethod t MessageHeadersIter, OverloadedMethod info MessageHeadersIter p) => IsLabel t (MessageHeadersIter -> p) Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods fromLabel :: MessageHeadersIter -> p #
type AttributeList MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter type AttributeList 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.

type family ResolveMessageHeadersIterMethod (t :: Symbol) o where ... Source #

Equations

ResolveMessageHeadersIterMethod "next" o = MessageHeadersIterNextMethodInfo
ResolveMessageHeadersIterMethod l o = MethodResolutionFailed l o :: Type

init

messageHeadersIterInit Source #

Arguments

:: (HasCallStack, MonadIO m)
=> MessageHeaders	`hdrs`: a `SoupMessageHeaders`
-> m MessageHeadersIter

Initializes iter for iterating hdrs.

(signature ~ m (Bool, Text, Text), MonadIO m) => OverloadedMethod MessageHeadersIterNextMethodInfo MessageHeadersIter signature Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods overloadedMethod :: MessageHeadersIter -> signature #
OverloadedMethodInfo MessageHeadersIterNextMethodInfo MessageHeadersIter Source #
Instance details Defined in GI.Soup.Structs.MessageHeadersIter Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

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.