diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-02-09 20:44:43 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-02-09 20:44:43 +0100 |
| commit | 8d0cea10adbe544c38ee458b9b2b67bba2c72959 (patch) | |
| tree | 25cfa294cb284ca21ffb0a8c3793471dc6804543 /libsha2_unmarshal.3 | |
| parent | Minor changes, add man pages, rename libsha2_state_initialise to libsha2_init (diff) | |
| download | libsha2-8d0cea10adbe544c38ee458b9b2b67bba2c72959.tar.gz libsha2-8d0cea10adbe544c38ee458b9b2b67bba2c72959.tar.bz2 libsha2-8d0cea10adbe544c38ee458b9b2b67bba2c72959.tar.xz | |
Add marshal and unmarshal functions
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libsha2_unmarshal.3')
| -rw-r--r-- | libsha2_unmarshal.3 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/libsha2_unmarshal.3 b/libsha2_unmarshal.3 new file mode 100644 index 0000000..52fa2d4 --- /dev/null +++ b/libsha2_unmarshal.3 @@ -0,0 +1,54 @@ +.TH LIBSHA2_UNMARSHAL 3 2019-02-09 libjson +.SH NAME +libsha2_unmarshal \- Unmarshal a SHA 2 hashing state +.SH SYNOPSIS +.nf +#include <libsha2.h> + +size_t libsha2_unmarshal(struct libsha2_state *restrict \fIstate\fP, const char *restrict \fIbuf\fP, size_t \fIbufsize\fP); +.fi +.PP +Link with +.IR \-lsha2 . +.SH DESCRIPTION +The +.BR libsha2_unmarshal () +function unmarshal +.I state +from the buffer +.IR buf . +.I bufsize +shall be the maximum number of bytes the +function may read from +.IR buf . +.SH RETURN VALUE +The +.BR libsha2_unmarshal () +function returns the number of unmarshalled +bytes (this number is always positive) upon +successful completion, otherwise 0 is returned. +.SH ERRORS +The +.BR libsha2_unmarshal () +function will fail if: +.TP +.B EINVAL +.I bufsize +is too small or the contents of +.I buf +is invalid or created with an incompatible +version of the library. +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR libsha2_marshal (3) |