docs/library/struct.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

:mod:`struct` -- pack and unpack primitive data types
=====================================================

.. module:: struct
   :synopsis: pack and unpack primitive data types

See `Python struct <https://docs.python.org/3/library/struct.html>`_ 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.