blob: d0f17809eb37b7db3c5a1987cf1272d290106b74 (
plain) (
tree)
|
|
.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_state_marshal - Marshals a hash state
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
size_t libkeccak_state_marshal(const libkeccak_state_t *\fIstate\fP, char *\fIdata\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_marshal ()
function marshals \fI*state\fP into the beginning
of \fIdata\fP.
.PP
Use the
.BR libkeccak_state_marshal_size (3)
function to get minimum usable allocation size
for \fIdata\fP.
.SH RETURN VALUES
The
.BR libkeccak_state_marshal ()
returns the number of bytes written to \fIdata\fP.
.SH ERRORS
The
.BR libkeccak_state_marshal ()
function cannot fail.
.SH SEE ALSO
.BR libkeccak_state_marshal_size (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
|
