struct -- Pack and unpack primitive data types.
===============================================
.. This document was autogenerated by Sphinx-autoapi from a .pyi stub or a source code file.
.. Do not edit this file, instead edit the source file and run Sphinx to update. 
.. Source: docs/stubs/struct/__init__.pyi

.. py:module:: struct

.. autoapi-nested-parse::

   Pack and unpack primitive data types.

   |see_cpython_module| :mod:`python:struct`.

   The following byte orders are supported:

   +-----------+------------------------+----------+-----------+
   | Character | Byte order             | Size     | Alignment |
   +===========+========================+==========+===========+
   | @         | native                 | native   | native    |
   +-----------+------------------------+----------+-----------+
   | <         | little-endian          | standard | none      |
   +-----------+------------------------+----------+-----------+
   | >         | big-endian             | standard | none      |
   +-----------+------------------------+----------+-----------+
   | !         | network (= big-endian) | standard | none      |
   +-----------+------------------------+----------+-----------+

   The following data types are supported:

   +--------+--------------------+-------------------+---------------+
   | Format | C Type             | Python type       | Standard size |
   +========+====================+===================+===============+
   | b      | signed char        | integer           | 1             |
   +--------+--------------------+-------------------+---------------+
   | B      | unsigned char      | integer           | 1             |
   +--------+--------------------+-------------------+---------------+
   | h      | short              | integer           | 2             |
   +--------+--------------------+-------------------+---------------+
   | H      | unsigned short     | integer           | 2             |
   +--------+--------------------+-------------------+---------------+
   | i      | int                | integer (`1<fn>`) | 4             |
   +--------+--------------------+-------------------+---------------+
   | I      | unsigned int       | integer (`1<fn>`) | 4             |
   +--------+--------------------+-------------------+---------------+
   | l      | long               | integer (`1<fn>`) | 4             |
   +--------+--------------------+-------------------+---------------+
   | L      | unsigned long      | integer (`1<fn>`) | 4             |
   +--------+--------------------+-------------------+---------------+
   | q      | long long          | integer (`1<fn>`) | 8             |
   +--------+--------------------+-------------------+---------------+
   | Q      | unsigned long long | integer (`1<fn>`) | 8             |
   +--------+--------------------+-------------------+---------------+
   | e      | n/a (half-float)   | float (`2<fn>`)   | 2             |
   +--------+--------------------+-------------------+---------------+
   | f      | float              | float (`2<fn>`)   | 4             |
   +--------+--------------------+-------------------+---------------+
   | d      | double             | float (`2<fn>`)   | 8             |
   +--------+--------------------+-------------------+---------------+
   | s      | char[]             | bytes             |               |
   +--------+--------------------+-------------------+---------------+
   | P      | void *             | integer           |               |
   +--------+--------------------+-------------------+---------------+



Functions
---------

.. autoapisummary::

   struct.calcsize
   struct.pack
   struct.pack_into
   struct.unpack
   struct.unpack_from


Module Contents
---------------

.. py:function:: calcsize(fmt) -> int

   Return the number of bytes needed to store the given *fmt*.


.. py:function:: pack(fmt, v1, *args, **kwargs) -> bytes

   Pack the values *v1*, *v2*, ... according to the format string *fmt*.
   The return value is a bytes object encoding the values.


.. py:function:: pack_into(fmt, buffer, offset, v1, *args, **kwargs) -> _typeshed.Incomplete

   Pack the values *v1*, *v2*, ... according to the format string *fmt*
   into a *buffer* starting at *offset*. *offset* may be negative to count
   from the end of *buffer*.


.. py:function:: unpack(fmt, data) -> Tuple

   Unpack from the *data* according to the format string *fmt*.
   The return value is a tuple of the unpacked values.


.. py:function:: unpack_from(fmt, data, offset=0) -> Tuple

   Unpack from the *data* starting at *offset* according to the format string
   *fmt*. *offset* may be negative to count from the end of *data*. The return
   value is a tuple of the unpacked values.