[DEV] Actions, Message Digests, Documentation Updates

[MatrixEditor]

Documentation Updates

• Tutorial is now split into multiple files
• Most of the common fields are now documented

Actions 🆕

An action can be used to execute custom logic (such as modifying the IO stream) before the next field is processed. For example, it could be used to trigger checksum or hash calculations before reading a struct field.

There are two types of actions:

1. Packing actions: triggered before packing the data into the struct (i.e., before serializing or encoding).
2. Unpacking actions: triggered before unpacking the data from the struct (i.e., before deserializing or decoding).

Example:

>>> def checksum_action(context: _ContextLike) -> None:
...     # This action could perform some checksum or logging logic
...     pass
...
>>> @struct
... class MyStruct:
...     some_field: Bytes(10)
...     checksum: Action(checksum_action) # runs only when packing

New Classes

• Alignedand Align
• Digest
• IOHook

Fixes and Changes

• uuidclass has been renamed to Uuid
• Pickled class got removed
• Renamed FormatField to PyStructFormattedField
• Prefixed now supports arbitrary structs
• Fixed an issue with S_ADD_BYTES resulting in an error when calling __bytes__