diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-10-06 20:10:48 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-10-06 20:10:48 +0200 |
| commit | 9b52d4e04c306529427bdd2e489b01bd1d423156 (patch) | |
| tree | 780e0ebcaf09bf24d88179a9a3a81b46aa39be02 /doc/man/libkeccak_state_marshal.3 | |
| parent | m (diff) | |
| download | libkeccak-9b52d4e04c306529427bdd2e489b01bd1d423156.tar.gz libkeccak-9b52d4e04c306529427bdd2e489b01bd1d423156.tar.bz2 libkeccak-9b52d4e04c306529427bdd2e489b01bd1d423156.tar.xz | |
add libkeccak_state_marshal.3, libkeccak_state_marshal_size.3, libkeccak_state_unmarshal.3, and libkeccak_state_unmarshal_skip.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/man/libkeccak_state_marshal.3')
| -rw-r--r-- | doc/man/libkeccak_state_marshal.3 | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/man/libkeccak_state_marshal.3 b/doc/man/libkeccak_state_marshal.3 new file mode 100644 index 0000000..52c8502 --- /dev/null +++ b/doc/man/libkeccak_state_marshal.3 @@ -0,0 +1,40 @@ +.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@member.fsf.org |