aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_state_marshal_size.3
diff options
context:
space:
mode:
Diffstat (limited to 'libkeccak_state_marshal_size.3')
-rw-r--r--libkeccak_state_marshal_size.331
1 files changed, 31 insertions, 0 deletions
diff --git a/libkeccak_state_marshal_size.3 b/libkeccak_state_marshal_size.3
new file mode 100644
index 0000000..9eca42b
--- /dev/null
+++ b/libkeccak_state_marshal_size.3
@@ -0,0 +1,31 @@
+.TH LIBKECCAK_STATE_MARSHAL_SIZE 3 LIBKECCAK
+.SH NAME
+libkeccak_state_marshal_size - Calculates the marshal-size of a hash state
+.SH SYNOPSIS
+.nf
+#include <libkeccak.h>
+
+size_t libkeccak_state_marshal_size(const libkeccak_state_t *\fIstate\fP);
+.fi
+.PP
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_marshal_size ()
+function calculates the number of bytes required
+to marshal
+.IR *state .
+.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)