Expand description
§airbender-codec

Documentation: API docs | Platform guide
[!WARNING] airbender-platform project is under active development and is in alpha state. Use at your own risk.
[!NOTE] Support crate. For guest programs, use
airbender-sdk, which re-exports this crate’s codec helpers viaairbender::codec. For host programs,airbender-hostexposes the codec through itsInputsAPI. Depend on this crate directly only when you need explicit control over encoded payloads.
airbender-codec defines the stable, versioned serialization layer used between host inputs and guest reads. It is no_std-compatible and currently exposes AirbenderCodecV0, built on bincode v2 with a fixed configuration.
§What It Provides
AirbenderCodec, the trait implemented by concrete codec versions.AirbenderCodecV0, the current codec used by the platform.AIRBENDER_CODEC_V0andCodecError, so manifests and callers can pin and validate the encoded payload format.
This crate sits underneath airbender-host::Inputs and airbender::guest::read, but it can also be used directly when you need explicit control over encoded payloads.
§Usage
[dependencies]
airbender-codec = { git = "https://github.com/matter-labs/airbender-platform", branch = "main" }§License
Licensed under either Apache License, Version 2.0 or MIT license at your option.
Structs§
- Airbender
Codec V0 - Initial codec based on
bincodev2 with a fixed configuration.
Enums§
Constants§
- AIRBENDER_
CODEC_ V0 - Stable codec version for host/guest communication.
Traits§
- Airbender
Codec - A stable, versioned serializer used by Airbender host and guest programs.