4 hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated
5 *****************************************************************
8 Create and destroy hashkit objects
16 C Library for hashing algorithms (libhashkit, -lhashkit)
27 #include <libhashkit/hashkit.h>
29 hashkit_st *hashkit_create(hashkit_st *hash);
31 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
33 void hashkit_free(hashkit_st *hash);
35 bool hashkit_is_allocated(const hashkit_st *hash);
44 The hashkit_create() function initializes a hashkit object for use. If
45 you pass a NULL argument for hash, then the memory for the object is
46 allocated. If you specify a pre-allocated piece of memory, that is
49 The hashkit_clone() function initializes a hashkit object much like
50 hashkit_create(), but instead of using default settings it will use
51 the settings of the ptr hashkit object.
53 The hashkit_free() frees any resources being consumed by the hashkit
54 objects that were initialized with hashkit_create() or hashkit_clone().
56 The hashkit_is_allocated() reports where the memory was allocated
65 hashkit_create() and hashkit_clone() will return NULL on failure or
68 hashkit_is_allocated() returns true if the memory for the hashkit
69 object was allocated inside of hashkit_create() or hashkit_clone(),
70 otherwise it is false and was user-supplied memory.
78 To find out more information please check:
79 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
87 Brian Aker, <brian@tangent.org>