Changeset 17964f6 in mainline

Timestamp:

2025-04-09T15:06:35Z (5 days ago)

Author:

GitHub <noreply@…>

Children:

2c94501

Parents:

f6b29929 (diff), 45226285 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Wayne Thornton <wmthornton-dev@…> (2025-04-09 15:06:35)

git-committer:

GitHub <noreply@…> (2025-04-09 15:06:35)

Message:

Merge pull request #1 from HelenOS/master

Clarify the purpose and use of hash_table_foreach()

File:

• common/include/adt/hash_table.h (modified) (1 diff)

common/include/adt/hash_table.h

@@ -85 +85 @@
         member_to_inst((item), type, member)
 
+/** Iterate over all entries associated with a given key.
+ * For iterating over all entries regardless of key, use hash_table_apply().
+ *
+ * Example:
+ * struct ht_entry {
+ *     ht_link_t my_link_member;
+ *     void *data;
+ *     int my_key;
+ * }
+ *
+ * hash_table_t *table = ...;
+ * int key = ...;
+ *
+ * hash_table_foreach(table, &key, my_link_member, struct ht_entry, item) {
+ *     _print_entry_data(item->data);
+ * }
+ */
 #define hash_table_foreach(ht, key, member, itype, iterator) \
         for (itype *iterator = NULL; \