Crate a3s_box_sdk 

a3s-box SDK — drive a3s-box from Rust.

Provides client: typed, runtime-backed local management APIs for boxes, pause/unpause/stop/remove/prune lifecycle transitions, images, volumes, networks, snapshot create/restore/list/remove/prune, image build/pull/push, and guest control sockets.

Re-exports

pub use client::A3sBoxClient;

pub use client::A3sBoxPaths;

pub use client::BoxLogLine;

pub use client::BoxStatsSummary;

pub use client::BoxSummary;

pub use client::BuildImage;

pub use client::BuildImageSummary;

pub use client::ClientError;

pub use client::CreateNetwork;

pub use client::CreateSnapshot;

pub use client::CreateVolume;

pub use client::ImageBuilder;

pub use client::ImageHealthCheckSummary;

pub use client::ImageHistoryEntry;

pub use client::ImageInspectSummary;

pub use client::ImageSummary;

pub use client::ListBoxesOptions;

pub use client::NetworkBuilder;

pub use client::NetworkEndpointSummary;

pub use client::NetworkSummary;

pub use client::PullImage;

pub use client::PushImage;

pub use client::PushImageSummary;

pub use client::ReadBoxLogsOptions;

pub use client::RegistryCredentials;

pub use client::RemoveBox;

pub use client::RemoveBoxSummary;

pub use client::RestoreSnapshot;

pub use client::Result;

pub use client::RuntimeDiagnostics;

pub use client::RuntimeDiskUsage;

pub use client::RuntimeVirtualizationSummary;

pub use client::SnapshotSummary;

pub use client::StopBox;

pub use client::StopBoxSummary;

pub use client::StopOutcome;

pub use client::TagImage;

pub use client::VolumeBuilder;

pub use client::VolumeSummary;

pub use sandbox::CommandResult;

pub use sandbox::CommandRunOptions;

pub use sandbox::Commands;

pub use sandbox::Filesystem;

pub use sandbox::FilesystemOptions;

pub use sandbox::Sandbox;

pub use sandbox::SandboxBuilder;

pub use sandbox::SandboxCommand;

pub use sandbox::SandboxCreateOptions;

pub use sandbox::SandboxInfo;

pub use sandbox::SandboxLogOptions;

pub use sandbox::SandboxNetwork;

pub use sandbox::SandboxRestartOptions;

pub use sandbox::ScriptBuilder;

pub use sandbox::TmpfsMount;

pub use sandbox::VolumeMount;

pub use sandbox::VolumeSource;

pub use sandbox::WriteInfo;

pub use sandbox::DEFAULT_SANDBOX_IMAGE;

pub use sandbox::DEFAULT_SANDBOX_TIMEOUT_SECONDS;

Modules

bridge

Versioned JSON bridge used by the pure Python and TypeScript SDKs.

client

Direct runtime-backed management API for a3s-box.

sandbox

E2B-style local Sandbox API backed directly by the A3S Box runtime.

Structs

AttestationPolicy

Policy for verifying SNP attestation reports.

AttestationReport

Attestation report returned from the guest VM.

AttestationRequest

Request for an attestation report from the guest VM.

BoxConfig

Box configuration

CreateExecutionRequest

A fully resolved request submitted to the runtime lifecycle facade.

ExecClient

Client for executing commands in the guest over Unix socket.

ExecOutput

Output from an executed command.

ExecRequest

Request to execute a command in the guest.

ExecutionGeneration

Runtime generation used to reject stale lifecycle operations.

ExecutionHealthCheck

Health-check behavior persisted with a local execution.

ExecutionId

Stable identifier assigned to one runtime execution.

ExecutionLease

Evidence returned when a runtime execution is ready.

ExecutionRecordPolicy

Caller-owned policy projected into the canonical local execution record.

ExecutionReservation

Durable evidence returned after an execution is created but not started.

ExecutionSnapshot

Result of atomically capturing one execution filesystem.

ExecutionSnapshotId

Opaque identifier for one runtime-managed filesystem snapshot.

ExecutionStatus

Current state and generation of one execution.

FileRequest

File transfer request for upload/download between host and guest.

FileResponse

File transfer response.

FilesystemEntry

Portable guest metadata used by compatibility protocol adapters.

FilesystemRequest

Generation-fenced filesystem request sent to the workload guest.

FilesystemResponse

Result of one workload filesystem metadata or mutation operation.

OperationId

Idempotency identity for a lifecycle operation.

Platform

A target platform (OS + architecture).

PortMapping

Parsed published-port mapping.

PtyClient

Client for interactive PTY sessions in the guest over Unix socket.

RaTlsAttestationClient

Client for verifying TEE attestation via RA-TLS handshake.

RegistryAuth

Authentication credentials for a container registry.

RestartExecutionOptions

Per-operation controls persisted with an idempotent restart.

StreamingExec

Handle for reading streaming exec events.

StreamingExecInput

Cloneable input side for a running streaming exec workload.

StreamingPty

Handle for reading PTY session output and exit status.

StreamingPtyInput

Cloneable input side for a running PTY session.

VerificationResult

Result of a complete attestation verification.

Enums

ExecutionIsolation

Execution isolation selected for a box.

ExecutionManagerError

Errors returned by the lifecycle facade without exposing backend internals.

ExecutionRestartPolicy

Restart behavior persisted with a local execution.

ExecutionState

Runtime state visible through the backend-neutral lifecycle facade.

FileOp

File transfer operation type.

FilesystemEntryKind

Entry type returned by a workload filesystem operation.

FilesystemOp

Metadata operation performed inside a managed workload filesystem.

KillOutcome

Result of an idempotent runtime kill request.

PortProtocol

Supported published-port protocol.

ReconcileOutcome

Runtime evidence recovered after a service restart.

RegistryProtocol

Transport protocol used for registry operations.

SignaturePolicy

Image signature verification policy.

Traits

ExecutionManager

Backend-neutral lifecycle facade shared by the CLI, SDK, and remote service.