Expand description
Abstract container runtime interface
Defines the Runtime trait that can be implemented for different container runtimes (containerd, CRI-O, etc.)
Structs§
- Archive
PutOptions - Options accepted by
Runtime::archive_put. - Commit
Options - Options accepted by
Runtime::commit_container. - Commit
Outcome - Result of a
Runtime::commit_containercall. - Container
- Container handle
- Container
Auth Context - Auth context injected into every container so it can talk back to the host API without needing external credentials.
- Container
Id - Container identifier
- Container
Inspect Details - Rich inspect details for a single container, returned by
Runtime::inspect_detailed. - Container
Prune Result - Result of a
Runtime::prune_containerscall. - Container
Resource Update - Resource-update payload passed to
Runtime::update_container_resources. - Container
Restart Policy Update - Runtime-level container restart policy attached to a
ContainerResourceUpdate. - Container
TopOutput - One row of process information returned by
Runtime::top_container. - Container
Update Outcome - Result of a
Runtime::update_container_resourcescall. Mirrors Docker’s{"Warnings": [...]}response shape: backends append a string per “we accepted this but did not apply it” or “field deprecated” warning. - Exec
Handle - Runtime-side handle returned by
Runtime::exec_pty. - Exec
Options - Options accepted by
Runtime::exec_pty. - Filesystem
Change Entry - One filesystem change reported by
Runtime::changes_container. - Health
Detail - Per-container health detail reported by
Runtime::inspect_detailed. - Image
History Entry - One row of an image’s history, returned by
Runtime::image_history. - Image
Info - Summary information about a cached image on the host runtime.
- Image
Inspect Info - Detailed image inspect record returned by
Runtime::inspect_image_native. - Image
Search Result - One result returned by
Runtime::search_images. - LogChunk
- One chunk of container log output emitted by
Runtime::logs_stream. - Logs
Stream Options - Options accepted by
Runtime::logs_stream. - Mock
Runtime - In-memory mock runtime for testing and development.
- Network
Attachment Detail - Per-network attachment reported by
Runtime::inspect_detailed. - Path
Stat - Stat metadata for a single path inside a container, returned by
Runtime::archive_head. - Port
Mapping Entry - One published port mapping entry returned by
Runtime::port_mappings_container. - Prune
Result - Result of a prune operation.
- Runtime
Container Summary - Lightweight summary of a single container reported by
Runtime::list_containers. - Stats
Sample - One periodic resource-usage sample emitted by
Runtime::stats_stream. - Wait
Outcome - Richer wait result returned by
Runtime::wait_outcome.
Enums§
- Container
State - Container state
- Exec
Event - One streaming event emitted by
Runtime::exec_stream. - Filesystem
Change Kind - Filesystem change kind reported by
Runtime::changes_container. - Load
Progress - One progress event emitted by
Runtime::load_images. - LogChannel
- Which standard stream a
LogChunkoriginated from. - Pull
Progress - One progress event emitted by
Runtime::pull_image_stream. - Wait
Condition - Wait condition mirroring Docker’s
POST /containers/{id}/wait?condition=. - Wait
Reason - Reason a container stopped running, as reported by
Runtime::wait_outcome.
Traits§
- Exec
Duplex - Marker supertrait combining
AsyncRead+AsyncWriteso they can be used together as a single trait object. Rust forbids stacking two non-auto traits directly indyn, soExecPtyStreamis built on top of this helper instead. - Runtime
- Abstract container runtime trait
Functions§
- signal_
name_ from_ exit_ code - Map a signal-style exit code (
128 + N) to a canonical signal name. - validate_
signal - Validate a signal name for
Runtime::kill_container.
Type Aliases§
- Archive
Stream - Boxed async stream of TAR-archive byte chunks returned by
Runtime::archive_get. - Exec
Event Stream - Boxed async stream of
ExecEvents returned byRuntime::exec_stream. - Exec
Exit Future - Future returned by
ExecHandlethat resolves with the exec’d process’s exit code once the runtime observes it has terminated. - Exec
PtyStream - Duplex byte stream used by
ExecHandleto shuttle stdin/stdout (and, whenExecOptions::ttyis set, multiplexed PTY traffic) between the caller and the exec’d process. - Image
Export Stream - Boxed async stream of TAR-archive byte chunks returned by image save /
container export endpoints. Each yielded
Bytesis a contiguous slice of an uncompressed TAR archive. - Load
Progress Stream - Boxed async stream of
LoadProgressevents returned byRuntime::load_images. - Logs
Stream - Boxed async stream of
Result<LogChunk, AgentError>items returned byRuntime::logs_stream. - Pull
Progress Stream - Boxed async stream of
Result<PullProgress, AgentError>items returned byRuntime::pull_image_stream. - Stats
Stream - Boxed async stream of
Result<StatsSample, AgentError>items returned byRuntime::stats_stream.