From 6e6dfdc56be2a5d6476d087043d2a4ccae139af2 Mon Sep 17 00:00:00 2001 From: Damien George Date: Sun, 2 Nov 2014 23:37:02 +0000 Subject: docs: Make custom index page; add more docs. --- docs/library/struct.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/library/struct.rst (limited to 'docs/library/struct.rst') diff --git a/docs/library/struct.rst b/docs/library/struct.rst new file mode 100644 index 0000000000..71ee5c9b70 --- /dev/null +++ b/docs/library/struct.rst @@ -0,0 +1,25 @@ +:mod:`struct` -- pack and unpack primitive data types +===================================================== + +.. module:: struct + :synopsis: pack and unpack primitive data types + +See `Python struct `_ for more +information. + +Functions +--------- + +.. function:: calcsize(fmt) + + Return the number of bytes needed to store the given ``fmt``. + +.. function:: pack(fmt, v1, v2, ...) + + Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``. + The return value is a bytes object encoding the values. + +.. function:: unpack(fmt, data) + + Unpack from the ``data`` according to the format string ``fmt``. + The return value is a tuple of the unpacked values. -- cgit v1.2.3