CK_HS_SET(3)

✨ CK_HS_SET(3) ✨

okay bestie, welcome to ck_hs_set — the store-a-key-in-a-hash-set girlie 💅 this one lives in the Concurrency Kit, aka libck, so link it with -lck and you're golden 🫶

📚 LIBRARY

Concurrency Kit (libck, -lck) — she's iconic, she's threaded, she's serving concurrency 🧚

🌸 SYNOPSIS

#include <ck_hs.h>

bool
ck_hs_set(ck_hs_t *hs, unsigned long hash, const void *key,
    void **previous);

like. look at her. four args. zero drama. ✨

💖 DESCRIPTION

so ck_hs_set(3) literally takes the key you hand it in the key argument and stores it inside the hash set that hs points to 🎀

but here's the tea ☕ — the key you pass is expected to already have the hash value you put in the hash argument, and that hash was previously generated using the CK_HS_HASH(3) macro. so like, don't just make one up, bestie, that's not the vibe 🙈

if the call to ck_hs_set(3) was successful, then your key was successfully stored in the hash set pointed to by hs. slay. ✅

and if the key already exists in the hash set? okay so then it gets replaced by key, and the previous value gets stored into the void pointer that previous points to 👑

⚠️ and if previous is set to NULL, then key was not a replacement for an existing entry in the hash set. no previous value for you, babe 💀

🌈 RETURN VALUES

upon successful completion, ck_hs_set(3) returns true 💚 otherwise it returns false on failure 😭 periodt.

🚨 ERRORS

behavior is undefined if key or hs are uninitialized. like genuinely undefined, we're not playing, don't do that 🙅♀️

the function will also return false if the hash set could not be enlarged to accomodate key insertion. she tried to grow, she couldn't, it's a whole thing 😔

👀 SEE ALSO

• ck_hs_init(3)
• ck_hs_move(3)
• ck_hs_destroy(3)
• CK_HS_HASH(3)
• ck_hs_iterator_init(3)
• ck_hs_next(3)
• ck_hs_get(3)
• ck_hs_put(3)
• ck_hs_put_unique(3)
• ck_hs_fas(3)
• ck_hs_remove(3)
• ck_hs_grow(3)
• ck_hs_gc(3)
• ck_hs_rebuild(3)
• ck_hs_count(3)
• ck_hs_reset(3)
• ck_hs_reset_size(3)
• ck_hs_stat(3)

additional information is available at http://concurrencykit.org/ 🌐

okay that's the whole page bestie, go forth and set your keys 💖✨🎀🦋🌸💅🫶

Concurrency Kit, September 17, 2012 — CK_HS_SET(3) 👑 no cap, that's the version and the date, mwah 💜