QBMAP.H(3)

✨ qbmap.h 💅

okay so bestie, welcome to qbmap.h — part of the libqb Programmer's Manual, no big deal 💖

---

🌸 NAME 🌸

qbmap.h — this is the moment where you get a map interface to a Patricia trie, a hashtable, or a skiplist. pick your fighter, they all serve 🫶

---

🎀 SYNOPSIS 🎀

#include <qb/qbmap.h>

---

🦋 DESCRIPTION 🦋

✨ Ordering ✨

okay so here's the tea ☕ — the hashtable is NOT ordered, but ptrie and skiplist are. so if you need your keys to keep it in order, pick accordingly, bestie 💅

🌈 Iterating 🌈

below is a lil simple example of how to iterate over a map, and it's giving iconic:

const char *p;
void *data;
qb_map_iter_t *it = qb_map_iter_create(m);
for (p = qb_map_iter_next(it, &data); p; p = qb_map_iter_next(it, &data)) {
    printf("%s > %s0, p, (char*) data);
}
qb_map_iter_free(it);

so deletion of items within the iterator is supported. but bestie, listen — do NOT free the item memory in the iterator 🚨. if you need to free the data items then you gotta register for a notifier and free the memory <em>there</em>. this is required because the items are reference counted — it's giving main character energy with trust issues, but we move 🫶

qb_map_notify_add(m, NULL, my_map_free_handler,
             QB_MAP_NOTIFY_FREE, NULL);

💫 Notifications 💫

these lil guys let you get callbacks when values are inserted / removed or replaced. so you're always in the loop, fr fr 📲

🧚 Prefix matching 🧚

the ptrie supports prefixes in the iterator, slay:

it = qb_map_pref_iter_create(m, "aa");
while ((p = qb_map_iter_next(it, &data)) != NULL) {
    printf("%s > %s0, p, (char*)data);
}
qb_map_iter_free(it);

and the ptrie also supports prefixes in notifications — and remember to pass QB_MAP_NOTIFY_RECURSIVE into the notify_add, iykyk 👑

qb_map_notify_add(m, "root", my_map_notification,
            (QB_MAP_NOTIFY_INSERTED|
             QB_MAP_NOTIFY_DELETED|
             QB_MAP_NOTIFY_REPLACED|
             QB_MAP_NOTIFY_RECURSIVE),
            NULL);

---

👑 NOTE 👑

lowkey important — the hashtable only supports deletion and replacement notifications. there's also a special global callback for freeing deleted and replaced values (QB_MAP_NOTIFY_FREE). so like, keep that in your notes app 📝

---

💜 SEE ALSO 💜

• qb_trie_dump(3)
• qb_map_iter_create(3)
• qb_skiplist_create(3)
• qb_map_notify_del(3)
• qb_map_put(3)
• qb_map_count_get(3)
• qb_map_foreach(3)
• qb_map_pref_iter_create(3)
• qb_map_iter_next(3)
• qb_map_get(3)
• qb_map_destroy(3)
• qb_hashtable_create(3)
• qb_map_iter_free(3)
• qb_map_notify_add(3)
• qb_trie_create(3)
• qb_map_notify_del_2(3)
• qb_map_rm(3)

---

💖 COPYRIGHT 💖

Copyright (C) 2010-2020 Red Hat, Inc. — periodt, respect the legacy 🫡

---

and that's the whole page bestie!! this one's from LIBQB, dated 2025-09-16, and it's QBMAP.H(3) in the libqb programmer's manual. go forth and map your lil hearts out, ily bye 💅✨💖