index.rst

####################
[plum] API Reference
####################

.. include:: ../alias.txt

.. currentmodule:: plum


**********
Plum Types
**********

    ==============================  ================================================
    Module                          Description
    ==============================  ================================================
    :mod:`plum.array`               list of uniformly typed
    :mod:`plum.bytearray`           array of bytes
    :mod:`plum.float`               floating point
    :mod:`plum.int`                 integer
    :mod:`plum.int.bitfields`       integer with bit field accessors
    :mod:`plum.int.enum`            integer enumerated constants
    :mod:`plum.int.flag`            integer with bit flags
    :mod:`plum.ipv4`                IPV4 address
    :mod:`plum.items`               collection of uniquely typed items
    :mod:`plum.nil`                 no bytes
    :mod:`plum.str`                 string
    :mod:`plum.structure`           predefined structure of uniquely typed members
    ==============================  ================================================

.. toctree::
    :hidden:

    array <types/array.rst>
    bytearray <types/bytearray.rst>
    float <types/float.rst>
    float.big <types/float_big.rst>
    float.little <types/float_little.rst>
    float.native <types/float_native.rst>
    int <types/int.rst>
    int.big <types/int_big.rst>
    int.little <types/int_little.rst>
    int.native <types/int_native.rst>
    int.bitfields <types/int_bitfields.rst>
    int.enum <types/int_enum.rst>
    int.flag <types/int_flag.rst>
    ipv4 <types/ipv4.rst>
    ipv4.big <types/ipv4_big.rst>
    ipv4.little <types/ipv4_little.rst>
    ipv4.native <types/ipv4_native.rst>
    items <types/items.rst>
    nil <types/nil.rst>
    str <types/str.rst>
    structure <types/structure.rst>


*****************
Utility Functions
*****************

    ===================================  ================================================================================
    Function                             Description
    ===================================  ================================================================================
    :func:`getbytes`                     Get bytes from bytes buffer.
    :func:`pack`                         Pack values as bytes following a format.
    :func:`pack_and_dump`                Pack values as bytes and produce bytes summary following a format.
    :func:`pack_into`                    Pack values as bytes into a buffer following a format.
    :func:`pack_into_and_dump`           Pack values as bytes into a buffer following a format and produce bytes summary.
    :func:`unpack`                       Unpack item(s) from bytes.
    :func:`unpack_and_dump`              Unpack item(s) from bytes and produce packed bytes summary.
    :func:`unpack_from`                  Unpack item(s) from within a bytes buffer.
    :func:`unpack_from_and_dump`         Unpack item(s) from within a bytes buffer and produce packed bytes summary.
    ===================================  ================================================================================

.. toctree::
    :hidden:

    getbytes() <utilities/getbytes.rst>
    pack() <utilities/pack.rst>
    pack_and_dump() <utilities/pack_and_dump.rst>
    pack_into() <utilities/pack_into.rst>
    pack_into_and_dump() <utilities/pack_into_and_dump.rst>
    unpack() <utilities/unpack.rst>
    unpack_from() <utilities/unpack_from.rst>
    unpack_and_dump() <utilities/unpack_and_dump.rst>
    unpack_from_and_dump() <utilities/unpack_from_and_dump.rst>


**********
Exceptions
**********

    - |ExcessMemoryError|
    - |InsufficientMemoryError|
    - |PackError|
    - |SizeError|
    - |UnpackError|


.. toctree::
    :hidden:

    ExcessMemoryError <exceptions/ExcessMemoryError.rst>
    InsufficientMemoryError <exceptions/InsufficientMemoryError.rst>
    PackError <exceptions/PackError.rst>
    SizeError <exceptions/SizeError.rst>
    UnpackError <exceptions/UnpackError.rst>