.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "HASHKIT_VALUE" "3" "Feb 01, 2024" "1.1" "libmemcached-awesome"
.SH NAME
hashkit_value \- libhashkit Documentation
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libhashkit\-1.0/hashkit.h>
Compile and link with \-lhashkit
.UNINDENT
.INDENT 0.0
.TP
.B uint32_t hashkit_value(\fI\%hashkit_st\fP *hash, const char *key, size_t key_length) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBhash\fP \-\- pointer to an initialized \fI\%hashkit_st\fP struct
.IP \(bu 2
\fBkey\fP \-\- the key to genereate a hash of
.IP \(bu 2
\fBkey_length\fP \-\- the length of the \fI\%key\fP without any terminating zero byte
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The \fI\%hashkit_value()\fP function generates a 32\-bit hash value from the given key
and key_length. The hash argument is an initialized hashkit object, and
distribution type and hash function is used from this object while generating
the value.
.SH RETURN VALUE
.sp
A 32\-bit hash value.
.SH SEE ALSO
.sp
\fBlibhashkit(3)\fP
\fBhashkit_create(3)\fP
\fBhashkit_function(3)\fP
\fBhashkit_functions(3)\fP
.\" Generated by docutils manpage writer.
.