aboutsummaryrefslogtreecommitdiffstats
path: root/man/libkeccak_state_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_state_marshal.3
parentChange style and license (diff)
downloadlibkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libkeccak_state_marshal.3')
-rw-r--r--man/libkeccak_state_marshal.341
1 files changed, 41 insertions, 0 deletions
diff --git a/man/libkeccak_state_marshal.3 b/man/libkeccak_state_marshal.3
new file mode 100644
index 0000000..f5d5e05
--- /dev/null
+++ b/man/libkeccak_state_marshal.3
@@ -0,0 +1,41 @@
+.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK
+.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
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_marshal ()
+function marshals \fI*state\fP 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)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se