Reference Manual

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

Packets

aligned_packet

Packets which align their fields.

packet

Base code for Packets.

packet_handler

Tools for handling Packets.

subpacket

Packets which are contained in other Packets.

Types

array

Types for contiguous data of the same Type.

default

Types for manipulating default values.

deferring

Types which defer their behavior to other Types.

enum

Enumeration Types.

misc

Miscellaneous Types.

numeric

Types for numbers.

optional

Types for marshaling data which might exist.

string

Types for strings.

type

Base code for Types.

I/O Facilities

connection

Contains io.Connection.

streams

Asynchronous data streams.

Utilities

aio

Asynchronous I/O utilities.

bits

Utilities related to binary operations.

decorators

Custom decorators.

exceptions

Custom exceptions.

inspection

Utilities for expanding upon the standard inspect module.

interfaces

Utilities for checking object interfaces.

misc

Miscellaneous utilities.

Other Modules

bit_field

Contains BitField.

dyn_value

Code for transforming certain values into dynamic values.

test

Utilities for testing, exposed for users to use as well.