Reference Manual
================

This document details functions, classes, and variables included in Pak, describing their functionality. To learn how to use Pak, see :doc:`tutorials`.

.. currentmodule:: pak

Packets
#######
.. autosummary::
    :toctree: reference
    :nosignatures:

    ~packets.aligned_packet
    ~packets.packet
    ~packets.packet_handler
    ~packets.subpacket

.. _reference-types:

Types
#####
.. autosummary::
    :toctree: reference
    :nosignatures:

    ~types.array
    ~types.default
    ~types.deferring
    ~types.enum
    ~types.misc
    ~types.numeric
    ~types.optional
    ~types.string
    ~types.type

I/O Facilities
##############
.. autosummary::
    :toctree: reference
    :nosignatures:

    ~io.connection
    ~io.streams

Utilities
#########
.. autosummary::
    :toctree: reference
    :nosignatures:

    ~util.aio
    ~util.bits
    ~util.decorators
    ~util.exceptions
    ~util.inspection
    ~util.interfaces
    ~util.misc

Other Modules
#############
.. autosummary::
    :toctree: reference
    :nosignatures:

    ~bit_field
    ~dyn_value
    ~test