aboutsummaryrefslogblamecommitdiffstats
path: root/doc/man/libkeccak_state_marshal_size.3
blob: a3123b8c1331d010ba66e3fc217cdf84a15c70b4 (plain) (tree)


































                                                                          
               
.TH LIBKECCAK_STATE_MARSHAL_SIZE 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_state_marshal_size - Calculates the marshal-size of a hash state
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
size_t libkeccak_state_marshal_size(const libkeccak_state_t *\fIstate\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_marshal_size ()
function calculates the number of bytes required
to marshal \fI*state\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_marshal_size ()
returns a positive value: the number of
bytes required to marshal the specified state.
.SH ERRORS
The
.BR libkeccak_state_marshal_size ()
function cannot fail.
.SH SEE ALSO
.BR libkeccak_state_marshal (3),
.BR libkeccak_state_unmarshal (3),
.BR libkeccak_state_unmarshal_skip (3)
.SH AUTHORS
Principal author, Mattias Andrée.  See the LICENSE file for the full
list of authors.
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se