Expand description
Checksummed framing and serialization codecs.
Structs§
- Decode
Limits - Independent wire and decompressed limits used to prevent compression bombs.
- Decoded
Frame - Decoded, integrity-checked protocol frame.
- Encode
Options - Encoding controls for one frame.
- Frame
Header - Validated fixed header. Reading this before the payload permits an oversized frame to be rejected without allocating its declared body.
Enums§
- Codec
Error - Wire decoding or encoding failure.
- Compression
- Optional payload compression selected after capability negotiation.
- Message
Kind - Frame message discriminator.
Constants§
- FLAG_
ZSTD - Frame flag indicating a zstd-compressed Postcard payload.
- HEADER_
LEN - Fixed header size: magic, version, flags, kind, length, and BLAKE3 digest.
- MAGIC
- Aequora protocol magic.
Functions§
- decode
- Decodes and deserializes a framed Postcard value of the expected kind.
- decode_
borrowed - Deserializes a borrowed typed view directly from an uncompressed stable frame buffer. The
returned value cannot outlive
frame, keeping borrowed lifetimes away from durable state. - decode_
frame - Validates and splits a frame without deserializing its payload.
- decode_
with_ limits - Decodes a frame with separate compressed-wire and decompressed payload limits.
- encode
- Encodes a serializable value as a checksummed Postcard Aequora frame.
- encode_
bytes - Encodes directly into immutable reference-counted bytes for transport handoff without a payload clone.
- encode_
bytes_ with_ options - Encodes a checksummed frame into a controlled
BytesMutconstruction buffer and freezes it for immutable sharing at the transport boundary. - encode_
with_ options - Encodes a checksummed frame with thresholded negotiated compression.
- inspect_
header - Validates the fixed frame preamble and declared length before callers allocate or read the payload body.