dictNext(3)

💖 dictNext(3) 💖

okay bestie, we're in util/dict.h territory and this one is literally the little iterator that could ✨

🌸 NAME 🌸

dictNext — search for next value in dictionary. that's it, that's the whole gig 💅

🎀 SYNOPSIS 🎀

#include <util/dict.h>

void *dictNext(dictCtx dict, char **id, void **plock);

🦋 ARGUMENTS 🦋

• dict — the dictionary you're iterating over. your main character, fr.
• id — pointer to the identifier of the last item you found, OR a pointer to NULL if you wanna grab the first one. lowkey the "where was I" bookmark 📖
• plock — a place for the value lock (or NULL if you don't want one, no pressure bestie).

✨ DESCRIPTION ✨

so you can use this to iterate through values in the dictionary. the way that it does that 💫

the order? it's the order of the hash of the ids. and ngl, that is not usefully externally. it's giving "chaos but make it deterministic" 🙈

it'll return the value if found, or NULL if not. simple as.

if <plock> is non-NULL, then the lock returned in <plock> gets associated with the returned value. and until you pass that lock to dictReleaseLock(), the value will not be passed to the dictCleanupFunc callback (see dictCleanup()). so like, hold onto that lock or the cleanup crew comes for your value, no cap 🔒

MT-Level: Safe if <dict> is thread-safe. periodt.

👑 RETURN VALUE 👑

• plock — set to value lock.
• id — pointer to id of found value. found her! 🎉

🌈 SEE ALSO 🌈

dictDestroy(3), dictCleanup(3), dictReleaseLock(3), dictRemove(3), dictNext(3), dictCreate(3), dictSetValue(3), dictModifyValue(3), dictSearch

(yes bestie, dictNext(3) is in its own SEE ALSO list. iconic behavior honestly 🫶)

and that's the whole page, mwah 💋 this came from ClearSilver, dated 12 July 2007 — yeah she's vintage but she ate and left no crumbs 🍓✨