Crate airbender_build 

airbender-build

Documentation: API docs | CLI build reference

[!WARNING] airbender-platform project is under active development and is in alpha state. Use at your own risk.

[!NOTE] Support crate. For normal build and project workflows, use cargo-airbender instead. Depend on this crate directly only when embedding the build and packaging flow in custom Rust tooling.

airbender-build compiles guest crates and packages the resulting dist/ bundle used by the rest of the platform. It is the library behind cargo airbender build, and is useful when you want to embed the same build and packaging flow in Rust tooling.

What It Provides

• BuildConfig for project path, binary selection, profile, target, dist output, forwarded Cargo args, and reproducible-build settings.
• build_dist(...) to compile a guest binary, extract app.bin, app.elf, and app.text, and write manifest.toml.
• Re-exports of the manifest schema from airbender-core, so host tooling can share one artifact format.

Reproducible builds run inside a pinned Docker container and record provenance metadata in the generated manifest.

Usage

[dependencies]
airbender-build = { git = "https://github.com/matter-labs/airbender-platform", branch = "main" }

Use cargo-airbender for normal CLI workflows. Reach for this crate when you need the same packaging behavior inside a custom build pipeline or host-side tool.

License

Licensed under either Apache License, Version 2.0 or MIT license at your option.

Structs

ArtifactEntry

One artifact entry recorded in the manifest.

BuildConfig

Input settings for guest compilation and dist packaging.

BuildMetadata

Build metadata captured while creating dist artifacts.

Manifest

Serialized manifest describing the build artifacts for a guest program.

Enums

BuildError

Unified error type for build and packaging operations.

Profile

Build profile recorded in the manifest for reproducibility.

Constants

CODEC_VERSION_V0

DEFAULT_GUEST_TARGET

DEFAULT_GUEST_TOOLCHAIN

MANIFEST_VERSION_V1

Functions

build_dist

Builds and packages guest artifacts using the provided configuration.

clean_reproducible_volumes

Removes the shared airbender-cargo-registry volume and any stopped airbender-build containers left by interrupted builds.

Type Aliases

Result

Convenience result alias for crate APIs.