GI.GLib.Structs.HashTableIter

A GHashTableIter structure represents an iterator that can be used to iterate over the elements of a HashTable. GHashTableIter structures are typically allocated on the stack and then initialized with hashTableIterInit.

Exported types

newtype HashTableIter

Constructors

HashTableIter (ManagedPtr HashTableIter)

Instances

WrappedPtr HashTableIter

Methods

wrappedPtrCalloc :: IO (Ptr HashTableIter)

wrappedPtrCopy :: HashTableIter -> IO HashTableIter

wrappedPtrFree :: Maybe (FunPtr (Ptr HashTableIter -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible HashTableIter tag

Methods

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

((~) * info (ResolveHashTableIterMethod t HashTableIter), MethodInfo * info HashTableIter p) => IsLabel t (HashTableIter -> p)

Methods

fromLabel :: Proxy# Symbol t -> HashTableIter -> p

((~) * info (ResolveHashTableIterMethod t HashTableIter), MethodInfo * info HashTableIter p) => IsLabelProxy t (HashTableIter -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> HashTableIter -> p

HasAttributeList * HashTableIter

((~) * signature (m ()), MonadIO m) => MethodInfo * HashTableIterStealMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterStealMethodInfo HashTableIter -> signature -> s

((~) * signature (Ptr () -> m ()), MonadIO m) => MethodInfo * HashTableIterReplaceMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterReplaceMethodInfo HashTableIter -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * HashTableIterRemoveMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterRemoveMethodInfo HashTableIter -> signature -> s

((~) * signature (m (Bool, Ptr (), Ptr ())), MonadIO m) => MethodInfo * HashTableIterNextMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterNextMethodInfo HashTableIter -> signature -> s

((~) * signature (Map (Ptr ()) (Ptr ()) -> m ()), MonadIO m) => MethodInfo * HashTableIterInitMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterInitMethodInfo HashTableIter -> signature -> s

type AttributeList HashTableIter

type AttributeList HashTableIter

newZeroHashTableIter :: MonadIO m => m HashTableIter

Construct a HashTableIter struct initialized to zero.

noHashTableIter :: Maybe HashTableIter

Methods

init

data HashTableIterInitMethodInfo

Instances

((~) * signature (Map (Ptr ()) (Ptr ()) -> m ()), MonadIO m) => MethodInfo * HashTableIterInitMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterInitMethodInfo HashTableIter -> signature -> s

hashTableIterInit

Arguments

:: (HasCallStack, MonadIO m)

=> HashTableIter

iter: an uninitialized HashTableIter

-> Map (Ptr ()) (Ptr ())

hashTable: a HashTable

-> m ()

Initializes a key/value pair iterator and associates it with hashTable. Modifying the hash table after calling this function invalidates the returned iterator.

C code

GHashTableIter iter;
gpointer key, value;

g_hash_table_iter_init (&iter, hash_table);
while (g_hash_table_iter_next (&iter, &key, &value))
  {
    // do something with key and value
  }

Since: 2.16

next

data HashTableIterNextMethodInfo

Instances

((~) * signature (m (Bool, Ptr (), Ptr ())), MonadIO m) => MethodInfo * HashTableIterNextMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterNextMethodInfo HashTableIter -> signature -> s

hashTableIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> HashTableIter

iter: an initialized HashTableIter

-> m (Bool, Ptr (), Ptr ())

Returns: False if the end of the HashTable has been reached.

Advances iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If False is returned, key and value are not set, and the iterator becomes invalid.

Since: 2.16

remove

data HashTableIterRemoveMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * HashTableIterRemoveMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterRemoveMethodInfo HashTableIter -> signature -> s

hashTableIterRemove

Arguments

:: (HasCallStack, MonadIO m)

=> HashTableIter

iter: an initialized HashTableIter

-> m ()

Removes the key/value pair currently pointed to by the iterator from its associated HashTable. Can only be called after hashTableIterNext returned True, and cannot be called more than once for the same key/value pair.

If the HashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself.

It is safe to continue iterating the HashTable afterward:

C code

while (g_hash_table_iter_next (&iter, &key, &value))
  {
    if (condition)
      g_hash_table_iter_remove (&iter);
  }

Since: 2.16

replace

data HashTableIterReplaceMethodInfo

Instances

((~) * signature (Ptr () -> m ()), MonadIO m) => MethodInfo * HashTableIterReplaceMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterReplaceMethodInfo HashTableIter -> signature -> s

hashTableIterReplace

Arguments

:: (HasCallStack, MonadIO m)

=> HashTableIter

iter: an initialized HashTableIter

-> Ptr ()

value: the value to replace with

-> m ()

Replaces the value currently pointed to by the iterator from its associated HashTable. Can only be called after hashTableIterNext returned True.

If you supplied a valueDestroyFunc when creating the HashTable, the old value is freed using that function.

Since: 2.30

steal

data HashTableIterStealMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * HashTableIterStealMethodInfo HashTableIter signature

Methods

overloadedMethod :: MethodProxy HashTableIterStealMethodInfo HashTableIter -> signature -> s

hashTableIterSteal

Arguments

:: (HasCallStack, MonadIO m)

=> HashTableIter

iter: an initialized HashTableIter

-> m ()

Removes the key/value pair currently pointed to by the iterator from its associated HashTable, without calling the key and value destroy functions. Can only be called after hashTableIterNext returned True, and cannot be called more than once for the same key/value pair.

Since: 2.16