Skip to main content

Module runtime

Module runtime 

Source
Expand description

Abstract container runtime interface

Defines the Runtime trait that can be implemented for different container runtimes (containerd, CRI-O, etc.)

Structs§

ArchivePutOptions
Options accepted by Runtime::archive_put.
CommitOptions
Options accepted by Runtime::commit_container.
CommitOutcome
Result of a Runtime::commit_container call.
Container
Container handle
ContainerAuthContext
Auth context injected into every container so it can talk back to the host API without needing external credentials.
ContainerId
Container identifier
ContainerInspectDetails
Rich inspect details for a single container, returned by Runtime::inspect_detailed.
ContainerPruneResult
Result of a Runtime::prune_containers call.
ContainerResourceUpdate
Resource-update payload passed to Runtime::update_container_resources.
ContainerRestartPolicyUpdate
Runtime-level container restart policy attached to a ContainerResourceUpdate.
ContainerTopOutput
One row of process information returned by Runtime::top_container.
ContainerUpdateOutcome
Result of a Runtime::update_container_resources call. Mirrors Docker’s {"Warnings": [...]} response shape: backends append a string per “we accepted this but did not apply it” or “field deprecated” warning.
ExecHandle
Runtime-side handle returned by Runtime::exec_pty.
ExecOptions
Options accepted by Runtime::exec_pty.
FilesystemChangeEntry
One filesystem change reported by Runtime::changes_container.
HealthDetail
Per-container health detail reported by Runtime::inspect_detailed.
ImageHistoryEntry
One row of an image’s history, returned by Runtime::image_history.
ImageInfo
Summary information about a cached image on the host runtime.
ImageInspectInfo
Detailed image inspect record returned by Runtime::inspect_image_native.
ImageSearchResult
One result returned by Runtime::search_images.
LogChunk
One chunk of container log output emitted by Runtime::logs_stream.
LogsStreamOptions
Options accepted by Runtime::logs_stream.
MockRuntime
In-memory mock runtime for testing and development.
NetworkAttachmentDetail
Per-network attachment reported by Runtime::inspect_detailed.
PathStat
Stat metadata for a single path inside a container, returned by Runtime::archive_head.
PortMappingEntry
One published port mapping entry returned by Runtime::port_mappings_container.
PruneResult
Result of a prune operation.
RuntimeContainerSummary
Lightweight summary of a single container reported by Runtime::list_containers.
StatsSample
One periodic resource-usage sample emitted by Runtime::stats_stream.
WaitOutcome
Richer wait result returned by Runtime::wait_outcome.

Enums§

ContainerState
Container state
ExecEvent
One streaming event emitted by Runtime::exec_stream.
FilesystemChangeKind
Filesystem change kind reported by Runtime::changes_container.
LoadProgress
One progress event emitted by Runtime::load_images.
LogChannel
Which standard stream a LogChunk originated from.
PullProgress
One progress event emitted by Runtime::pull_image_stream.
WaitCondition
Wait condition mirroring Docker’s POST /containers/{id}/wait?condition=.
WaitReason
Reason a container stopped running, as reported by Runtime::wait_outcome.

Traits§

ExecDuplex
Marker supertrait combining AsyncRead + AsyncWrite so they can be used together as a single trait object. Rust forbids stacking two non-auto traits directly in dyn, so ExecPtyStream is 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§

ArchiveStream
Boxed async stream of TAR-archive byte chunks returned by Runtime::archive_get.
ExecEventStream
Boxed async stream of ExecEvents returned by Runtime::exec_stream.
ExecExitFuture
Future returned by ExecHandle that resolves with the exec’d process’s exit code once the runtime observes it has terminated.
ExecPtyStream
Duplex byte stream used by ExecHandle to shuttle stdin/stdout (and, when ExecOptions::tty is set, multiplexed PTY traffic) between the caller and the exec’d process.
ImageExportStream
Boxed async stream of TAR-archive byte chunks returned by image save / container export endpoints. Each yielded Bytes is a contiguous slice of an uncompressed TAR archive.
LoadProgressStream
Boxed async stream of LoadProgress events returned by Runtime::load_images.
LogsStream
Boxed async stream of Result<LogChunk, AgentError> items returned by Runtime::logs_stream.
PullProgressStream
Boxed async stream of Result<PullProgress, AgentError> items returned by Runtime::pull_image_stream.
StatsStream
Boxed async stream of Result<StatsSample, AgentError> items returned by Runtime::stats_stream.