API#

The API docs are generated from the docstrings, so are also available via the help() function in a Python interpreter session.

The public API is grouped into:

  • Tibs — An immutable sequence of bits.

  • Mutibs — A mutable sequence of bits.

  • Dtype — Fixed-width data type descriptions used for packing and unpacking values.

  • View and MutableView — Wrappers for byte order, bit order and labelled fields.

  • Enums — Enum classes for byte order, bit order, dtypes and codecs.