StaticaddThis is a convenience function for using a GLib.HashTable as a set. It
is equivalent to calling g_hash_table_replace() with key as both the
key and the value.
In particular, this means that if key already exists in the hash table, then
the old copy of key in the hash table is freed and key replaces it in the
table.
When a hash table only ever contains keys that have themselves as the corresponding value it is able to be stored more efficiently. See the discussion in the section description.
Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.
StaticcontainsStaticdestroyDestroys all keys and values in the GLib.HashTable and decrements its
reference count by 1. If keys and/or values are dynamically allocated,
you should either free them first or create the GLib.HashTable with destroy
notifiers using g_hash_table_new_full(). In the latter case the destroy
functions you supplied will be called on all keys and values during the
destruction phase.
StaticfindCalls the given function for key/value pairs in the GLib.HashTable
until predicate returns true. The function is passed the key
and value of each pair, and the given user_data parameter. The
hash table may not be modified while iterating over it (you can't
add/remove items).
Note, that hash tables are really only optimized for forward
lookups, i.e. g_hash_table_lookup(). So code that frequently issues
g_hash_table_find() or g_hash_table_foreach() (e.g. in the order of
once per every entry in a hash table) should probably be reworked
to use additional or different data structures for reverse lookups
(keep in mind that an O(n) find/foreach operation issued for all n
values in a hash table ends up needing O(n*n) operations).
StaticforeachCalls the given function for each of the key/value pairs in the
GLib.HashTable. The function is passed the key and value of each
pair, and the given user_data parameter. The hash table may not
be modified while iterating over it (you can't add/remove
items). To remove all items matching a predicate, use
g_hash_table_foreach_remove().
The order in which g_hash_table_foreach() iterates over the keys/values in
the hash table is not defined.
See g_hash_table_find() for performance caveats for linear
order searches in contrast to g_hash_table_lookup().
Staticforeach_Calls the given function for each key/value pair in the
GLib.HashTable. If the function returns true, then the key/value
pair is removed from the GLib.HashTable. If you supplied key or
value destroy functions when creating the GLib.HashTable, they are
used to free the memory allocated for the removed keys and values.
See GLib.HashTableIter for an alternative way to loop over the key/value pairs in the hash table.
Staticforeach_Calls the given function for each key/value pair in the
GLib.HashTable. If the function returns true, then the key/value
pair is removed from the GLib.HashTable, but no key or value
destroy functions are called.
See GLib.HashTableIter for an alternative way to loop over the key/value pairs in the hash table.
StaticinsertInserts a new key and value into a GLib.HashTable.
If the key already exists in the GLib.HashTable its current
value is replaced with the new value. If you supplied a
value_destroy_func when creating the GLib.HashTable, the old
value is freed using that function. If you supplied a
key_destroy_func when creating the GLib.HashTable, the passed
key is freed using that function.
Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.
StaticlookupLooks up a key in a GLib.HashTable. Note that this function cannot
distinguish between a key that is not present and one which is present
and has the value null. If you need this distinction, use
g_hash_table_lookup_extended().
Staticlookup_Looks up a key in the GLib.HashTable, returning the original key and the
associated value and a gboolean which is true if the key was found. This
is useful if you need to free the memory allocated for the original key,
for example before calling g_hash_table_remove().
You can actually pass null for lookup_key to test
whether the null key exists, provided the hash and equal functions
of hash_table are null-safe.
Staticnew_Creates a new GLib.HashTable like g_hash_table_new_full() with a reference
count of 1.
It inherits the hash function, the key equal function, the key destroy function,
as well as the value destroy function, from other_hash_table.
The returned hash table will be empty; it will not contain the keys
or values from other_hash_table.
Another GLib.HashTable
StaticrefAtomically increments the reference count of hash_table by one.
This function is MT-safe and may be called from any thread.
a valid GLib.HashTable
StaticremoveRemoves a key and its associated value from a GLib.HashTable.
If the GLib.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.
Staticremove_Removes all keys and their associated values from a GLib.HashTable.
If the GLib.HashTable was created using g_hash_table_new_full(),
the keys and values are freed using the supplied destroy functions,
otherwise you have to make sure that any dynamically allocated
values are freed yourself.
StaticreplaceInserts a new key and value into a GLib.HashTable similar to
g_hash_table_insert(). The difference is that if the key
already exists in the GLib.HashTable, it gets replaced by the
new key. If you supplied a value_destroy_func when creating
the GLib.HashTable, the old value is freed using that function.
If you supplied a key_destroy_func when creating the
GLib.HashTable, the old key is freed using that function.
Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.
StaticsizeStaticstealRemoves a key and its associated value from a GLib.HashTable without calling the key and value destroy functions.
Staticsteal_Removes all keys and their associated values from a GLib.HashTable without calling the key and value destroy functions.
Staticsteal_Looks up a key in the GLib.HashTable, stealing the original key and the
associated value and returning true if the key was found. If the key was
not found, false is returned.
If found, the stolen key and value are removed from the hash table without
calling the key and value destroy functions, and ownership is transferred to
the caller of this method, as with g_hash_table_steal(). That is the case
regardless whether stolen_key or stolen_value output parameters are
requested.
You can pass null for lookup_key, provided the hash and equal functions
of hash_table are null-safe.
The dictionary implementation optimizes for having all values identical to
their keys, for example by using g_hash_table_add(). Before 2.82, when
stealing both the key and the value from such a dictionary, the value was
null. Since 2.82, the returned value and key will be the same.
StaticunrefAtomically decrements the reference count of hash_table by one.
If the reference count drops to 0, all keys and values will be
destroyed, and all memory allocated by the hash table is released.
This function is MT-safe and may be called from any thread.
a valid GLib.HashTable
The GLib.HashTable struct is an opaque data structure to represent a Hash Table. It should only be accessed via the following functions.