docs: sanitize

[awesomized/libmemcached] / docs / source / libhashkit / hashkit_functions.rst

diff --git a/docs/source/libhashkit/hashkit_functions.rst b/docs/source/libhashkit/hashkit_functions.rst
new file mode 100644 (file)
index 0000000..d55ca5c
--- /dev/null
+++ b/docs/source/libhashkit/hashkit_functions.rst
@@ -0,0 +1,65 @@
+Available Hashes
+================
+
+.. index:: object: hashkit_st
+
+Various hash functions to use for calculating hash values for keys
+
+SYNOPSIS
+--------
+
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
+.. function:: uint32_t hashkit_default(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
+
+.. function:: uint32_t hashkit_md5(const char *key, size_t key_length)
+
+DESCRIPTION
+-----------
+
+These functions generate hash values from a key using a variety of
+algorithms. These functions can be used standalone, or as arguments
+to :func:`hashkit_set_hash_fn` or :func:`hashkit_set_continuum_hash_fn`.
+
+The :func:`hashkit_hsieh` is only available if the library is built with
+the appropriate flag enabled.
+
+RETURN VALUE
+------------
+
+A 32-bit hash value.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+
+.. only:: html
+
+    * :doc:`../libhashkit`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_function`
+