HASHKIT_GET_DISTRIBUTION_FUNCTION(3)

💖 NAME 💖

hashkit_get_distribution_function — the libhashkit documentation, bestie. It's from libmemcached-awesome, and yes she's that girl. 🎀

---

✨ SYNOPSIS ✨

#include <libhashkit-1.0/hashkit.h>

Compile and link with -lhashkit — don't forget this part, it's giving "why won't it link" energy otherwise 😭

typedef uint32_t (*hashkit_hash_fn)(const char *key, size_t key_length,
void *context)

Okay so this is the custom hash function shape, and here's what every piece means:

• Param key — the key we're generating a hash of 💅
• Param key_length — how long that key is, without any terminating zero byte (no sneaky \0 counting, she's not about that life)
• Param context — the custom hash function context that got set through hashkit_set_custom_function() or hashkit_set_custom_distribution_function()
• Returns — your custom hash function should hand back a hash value for key as an unsigned 32bit integer ✨

typedef enum hashkit_return_t hashkit_return_t

enum hashkit_return_t

• enumerator HASHKIT_SUCCESS — operation succeeded. slay. 👑
• enumerator HASHKIT_FAILURE — operation failed. 💀
• enumerator HASHKIT_MEMORY_ALLOCATION_FAILURE — memory allocation failed. she's out of room, no cap.
• enumerator HASHKIT_INVALID_HASH — invalid hashkit_hash_algorithm_t passed.
• enumerator HASHKIT_INVALID_ARGUMENT — invalid argument passed.

typedef enum hashkit_hash_algorithm_t hashkit_hash_algorithm_t

enum hashkit_hash_algorithm_t

• enumerator HASHKIT_HASH_DEFAULT — the default hash algorithm, which is one_at_a_time. the OG, the blueprint.
• enumerator HASHKIT_HASH_MD5
• enumerator HASHKIT_HASH_CRC
• enumerator HASHKIT_HASH_FNV1_64
• enumerator HASHKIT_HASH_FNV1A_64
• enumerator HASHKIT_HASH_FNV1_32
• enumerator HASHKIT_HASH_FNV1A_32
• enumerator HASHKIT_HASH_HSIEH — only available if libhashkit hash been built with HSIEH support. (that typo is in the original, we're keeping it, it's canon now 🙈)
• enumerator HASHKIT_HASH_MURMUR — only available if libhashkit has been built with MURMUR support.
• enumerator HASHKIT_HASH_MURMUR3 — only available if libhashkit has been built with MURMUR support.
• enumerator HASHKIT_HASH_JENKINS
• enumerator HASHKIT_HASH_CUSTOM — use the custom hashkit_hash_fn function set through hashkit_set_custom_function() or hashkit_set_custom_distribution_function(). your own lil invention, main character energy fr fr ✨

---

hashkit_return_t hashkit_set_function(hashkit_st *hash,
hashkit_hash_algorithm_t hash_algorithm)

Parameters

• hash -- pointer to an initialized hashkit_st struct
• hash_algorithm -- valid hashkit_hash_algorithm_t constant

Returns

hashkit_return_t indicating success or failure 🫶

---

hashkit_return_t hashkit_set_custom_function(hashkit_st *hash,
hashkit_hash_fn function, void *context)

Parameters

• hash -- pointer to initialized hashkit_st struct
• function -- hashkit_hash_fn function pointer to use as hash function for HASHKIT_HASH_CUSTOM
• context -- pointer to an opaque user managed context for the custom hash function

Returns

hashkit_return_t indicating success or failure 💜

---

hashkit_hash_algorithm_t hashkit_get_function(const hashkit_st *hash)

Parameters

• hash -- pointer to an initialized hashkit_st struct

Returns

hashkit_hash_algorithm_t indicating the currently set hash algorithm to use 🌸

---

hashkit_return_t hashkit_set_distribution_function(hashkit_st *hash,
hashkit_hash_algorithm_t hash_algorithm)

Parameters

• hash -- pointer to an initialized hashkit_st struct
• hash_algorithm -- valid hashkit_hash_algrothm_t constant

Returns

hashkit_return_t indicating success or failure ✨

---

hashkit_return_t hashkit_set_custom_distribution_function(hashkit_st
*hash, hashkit_hash_fn function, void *context)

Parameters

• hash -- pointer to initialized hashkit_st struct
• function -- hashkit_hash_fn function pointer to use as distribution hash function for HASHKIT_HASH_CUSTOM
• context -- pointer to an opaque user managed context for the custom distribution hash function

---

hashkit_hash_algorithm_t hashkit_get_distribution_function(const
hashkit_st *hash)

Parameters

• hash -- pointer to an initialized hashkit_st struct

Returns

hashkit_hash_algorithm_t indicating the currently set distribution hash algorithm to use. yes, the distribution one. different function, different vibe. 🌈

---

🌟 DESCRIPTION 🌟

So these functions are the whole little squad that sets and retrieves the key hash functions and the distribution hash functions. That's it, that's the job. Simple. Iconic. 💅

---

🎀 RETURN VALUE 🎀

hashkit_set_function(), hashkit_set_custom_function() and the distribution equivalents all return hashkit_return_t::HASHKIT_SUCCESS when they succeed. 🥳

hashkit_get_function() and hashkit_get_distribution_function() return hashkit_hash_algorithm_t, telling you which hash function is being used. iykyk. ✨

---

👀 SEE ALSO 👀

libhashkit(3) hashkit_create(3) hashkit_functions(3) — go read those too bestie, they're part of the lore 🦋

---

Okay that's the whole page, mwah 💖 this was libmemcached-awesome version 1.1, dated Jul 24, 2025 — thanks for coming to my TED talk, go hash something responsibly, ily, bye!! 🎀✨🫶