Skip to main content

Crate boxlite

Crate boxlite 

Source
Expand description

Boxlite runtime library.

This crate provides the host-side API for managing Boxlite sandboxes.

Re-exports§

pub use litebox::LiteBox;
pub use runtime::BoxliteRuntime;
pub use runtime::ImageHandle;
pub use litebox::SnapshotHandle;
pub use litebox::BoxCommand;
pub use litebox::CopyOptions;
pub use litebox::ExecResult;
pub use litebox::ExecStderr;
pub use litebox::ExecStdin;
pub use litebox::ExecStdout;
pub use litebox::Execution;
pub use litebox::ExecutionId;
pub use litebox::HealthState;
pub use litebox::HealthStatus;
pub use metrics::BoxMetrics;
pub use metrics::RuntimeMetrics;
pub use runtime::advanced_options::AdvancedBoxOptions;
pub use runtime::advanced_options::HealthCheckOptions;
pub use runtime::advanced_options::ResourceLimits;
pub use runtime::advanced_options::SecurityOptions;
pub use runtime::options::BoxArchive;
pub use runtime::options::BoxOptions;
pub use runtime::options::BoxliteOptions;
pub use runtime::options::CloneOptions;
pub use runtime::options::ExportOptions;
pub use runtime::options::RootfsSpec;
pub use runtime::options::SnapshotOptions;
pub use runtime::id::BaseDiskID;
pub use runtime::id::BaseDiskIDMint;
pub use runtime::id::BoxID;
pub use runtime::id::BoxIDMint;
pub use runtime::types::ContainerID;
pub use runtime::types::BoxInfo;
pub use runtime::types::BoxState;
pub use runtime::types::BoxStateInfo;
pub use runtime::types::BoxStatus;

Modules§

jailer
Jailer module for BoxLite security isolation.
litebox
LiteBox - Individual box lifecycle management
lock
Lock management for per-entity multiprocess-safe locking.
metrics
Metrics collection for Boxlite runtime.
net
Network backend abstraction for Boxes.
pipeline
Generic table-driven pipeline execution framework.
runtime
util
vmm
Engine abstraction for Boxlite runtime.

Structs§

ArchiveManifest
Archive manifest stored as manifest.json inside exported archives.
DiskInfo
Serializable disk path + size metadata.
GuestSession
High-level guest session.
SnapshotInfo
Public-facing snapshot metadata.

Enums§

BoxliteError

Constants§

VERSION
Boxlite library version (from CARGO_PKG_VERSION at compile time).

Functions§

init_logging_for
Initialize tracing for Boxlite using the provided filesystem layout.

Type Aliases§

BoxliteResult
Result type for Boxlite operations.