HASHKIT_GET_FUNCTION(3)

📦
version 1.1.4 · 12 versions
, in fedora 43

🎀 NAME 🎀

okay so this is hashkit_get_function from the libhashkit Documentation (and yeah, the whole page you're reading lives in the libmemcached-awesome manual, section 3, bestie 💅).

✨ SYNOPSIS ✨

#include <libhashkit-1.0/hashkit.h>
       Compile and link with -lhashkit

yes queen, that's the header and the linker flag, no notes 💖

🦋 the function pointer type, aka the whole personality

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

here's what each lil param means:

  • key — the key to generate a hash of
  • key_length — the length of the key without any terminating zero byte (so don't you dare count the \0, babe 🙈)
  • context — the custom hash function context set through hashkit_set_custom_function() or hashkit_set_custom_distribution_function()

Returns — the custom hash function should return a hash value for key as an unsigned 32bit integer ✨

🌸 the return type

typedef enum hashkit_return_t hashkit_return_t
enum hashkit_return_t

and the enumerators, one by one, no skips:

  • HASHKIT_SUCCESS — Operation succeeded. slay 💅
  • HASHKIT_FAILURE — Operation failed. not slay 😭
  • HASHKIT_MEMORY_ALLOCATION_FAILURE — Memory allocation failed. the malloc said no 💀
  • HASHKIT_INVALID_HASH — Invalid hashkit_hash_algorithm_t passed.
  • HASHKIT_INVALID_ARGUMENT — Invalid argument passed.

🌈 the algorithm type, the menu of vibes

typedef enum hashkit_hash_algorithm_t hashkit_hash_algorithm_t
enum hashkit_hash_algorithm_t
  • HASHKIT_HASH_DEFAULT — Default hash algorithm (one_at_a_time). the main character 🫶
  • HASHKIT_HASH_MD5
  • HASHKIT_HASH_CRC
  • HASHKIT_HASH_FNV1_64
  • HASHKIT_HASH_FNV1A_64
  • HASHKIT_HASH_FNV1_32
  • HASHKIT_HASH_FNV1A_32
  • HASHKIT_HASH_HSIEH — Only available if libhashkit hash been built with HSIEH support.
  • HASHKIT_HASH_MURMUR — Only available if libhashkit has been built with MURMUR support.
  • HASHKIT_HASH_MURMUR3 — Only available if libhashkit has been built with MURMUR support.
  • HASHKIT_HASH_JENKINS
  • HASHKIT_HASH_CUSTOM — Use custom hashkit_hash_fn function set through hashkit_set_custom_function() or hashkit_set_custom_distribution_function(). build-a-bear but it's a hash function 🧚

👑 the actual functions

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

💜 DESCRIPTION 💜

okay so the whole point of these functions: they're used to set and retrieve the key and distribution hash functions. that's it, that's the tea ☕ set one, get one, set the distribution one, get the distribution one. obsessed.

⭐ RETURN VALUE ⭐

hashkit_set_function(), hashkit_set_custom_function() and the distribution equivalents return hashkit_return_t::HASHKIT_SUCCESS on success. 🎉

hashkit_get_function() and hashkit_get_distribution_function() return hashkit_hash_algorithm_t indicating the hash function used. 👑

🔥 SEE ALSO 🔥

and that's the whole page, bestie!! this one came out of libmemcached-awesome, version 1.1, dated Jul 24, 2025 — go forth and hash responsibly, ily 💖✨🦋

📦 where this page comes from