diff options
Diffstat (limited to 'libkeccak_state_marshal.3')
-rw-r--r-- | libkeccak_state_marshal.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/libkeccak_state_marshal.3 b/libkeccak_state_marshal.3 new file mode 100644 index 0000000..ae21d17 --- /dev/null +++ b/libkeccak_state_marshal.3 @@ -0,0 +1,38 @@ +.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK +.SH NAME +libkeccak_state_marshal - Marshals a hash state +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +size_t libkeccak_state_marshal(const libkeccak_state_t *\fIstate\fP, void *\fIdata\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_state_marshal () +function marshals +.I *state +into the beginning of +.IR data . +.PP +Use the +.BR libkeccak_state_marshal_size (3) +function to get minimum usable allocation size +for +.IR data . +.SH RETURN VALUES +The +.BR libkeccak_state_marshal () +returns the number of bytes written to +.IR data . +.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) |