aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_unmarshal_skip.3
blob: b87386c5cb78ccd3bb22a9bec01318be7818a558 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.TH LIBKECCAK_STATE_UNMARSHAL_SKIP 3 LIBKECCAK
.SH NAME
libkeccak_state_unmarshal_skip - Calculates the marshal-size of a marshalled hash state
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
size_t
libkeccak_state_unmarshal_skip(const char *\fIdata\fP);
.fi
.P
Link with
.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_state_unmarshal_skip ()
function gets the number of bytes with which
the hash state in the beginning of
.I data
is store stored. This is useful if you do not
want to unmarshal the state.
.SH RETURN VALUES
The
.BR libkeccak_state_unmarshal_skip ()
returns a positive value: the number of
bytes to skip forward to skip pass the
hash state stored at the beginning of
the buffer.
.SH ERRORS
The
.BR libkeccak_state_unmarshal_skip ()
function cannot fail.
.SH SEE ALSO
.BR libkeccak_state_marshal_size (3),
.BR libkeccak_state_marshal (3),
.BR libkeccak_state_unmarshal (3)
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se