index.rst 3.33 KB
Newer Older
Dan Gass's avatar
Dan Gass committed
1 2 3
################
[plum] Reference
################
4 5 6

.. include:: ../alias.txt

Dan Gass's avatar
Dan Gass committed
7 8
.. currentmodule:: plum

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

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

    ==============================  =============================================================
    Function                        Description
    ==============================  =============================================================
    :func:`calcsize`                Get size of packed item (in bytes).
    :func:`dump`                    Print packed memory summary.
    :func:`getdump`                 Get packed memory summary.
    :func:`pack`                    Pack items into bytes.
    :func:`pack_and_getdump`        Pack items into bytes and get packed memory summary.
    :func:`unpack`                  Unpack item from memory bytes.
    :func:`unpack_and_getdump`      Unpack item from memory bytes and get packed memory summary.
    ==============================  =============================================================

.. toctree::
    :hidden:

Dan Gass's avatar
Dan Gass committed
29 30 31 32 33 34 35
    calcsize() <utilities/calcsize.rst>
    dump() <utilities/dump.rst>
    getdump() <utilities/getdump.rst>
    pack() <utilities/pack.rst>
    pack_and_getdump() <utilities/pack_and_getdump.rst>
    unpack() <utilities/unpack.rst>
    unpack_and_getdump() <utilities/unpack_and_getdump.rst>
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51


*******
Classes
*******

    ============================  ===========================
    Class                         Description
    ============================  ===========================
    |Memory|                      Memory unpack manager
    ============================  ===========================


.. toctree::
    :hidden:

Dan Gass's avatar
Dan Gass committed
52
    Memory <classes/Memory.rst>
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68


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

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


.. toctree::
    :hidden:

Dan Gass's avatar
Dan Gass committed
69 70 71 72 73
    ExcessMemoryError <exceptions/ExcessMemoryError.rst>
    InsufficientMemoryError <exceptions/InsufficientMemoryError.rst>
    PackError <exceptions/PackError.rst>
    SizeError <exceptions/SizeError.rst>
    UnpackError <exceptions/UnpackError.rst>
74 75 76 77 78 79 80 81 82 83 84 85


*******
Modules
*******

    ==============================  ================================================
    Module                          Description
    ==============================  ================================================
    :mod:`plum.array`               list of uniformly typed items
    :mod:`plum.int`                 integer base class
    :mod:`plum.int.big`             big endian integers
86 87
    :mod:`plum.int.bitfields`       integer with bitfield accessors
    :mod:`plum.int.bitflags`        integer with bit accessors
88
    :mod:`plum.int.little`          little endian integers
89
    :mod:`plum.int.native`          native endian integers
90 91 92 93 94 95 96 97
    :mod:`plum.sequence`            list of uniquely typed items
    :mod:`plum.structure`           dictionary of named, uniquely typed items
    ==============================  ================================================


.. toctree::
    :hidden:

Dan Gass's avatar
Dan Gass committed
98 99 100
    array <modules/array.rst>
    int <modules/int.rst>
    int.big <modules/int_big.rst>
101 102
    int.bitfields <modules/int_bitfields.rst>
    int.bitflags <modules/int_bitflags.rst>
Dan Gass's avatar
Dan Gass committed
103 104 105 106
    int.little <modules/int_little.rst>
    int.native <modules/int_native.rst>
    sequence <modules/sequence.rst>
    structure <modules/structure.rst>