Struct Docker 

pub struct Docker { /* private fields */ }

The local Docker Engine.

Implementations

impl Docker

pub fn connect() -> Result<Docker, Error>

Connects to the Docker Engine at DOCKER_HOST, or its local socket. Only unix:// hosts are supported.

pub async fn info(&self) -> Result<SystemInfo, Error>

The Engine’s system information.

pub async fn image_labels( &self, image: &str, ) -> Result<Option<HashMap<String, String>>, Error>

An image’s labels; None when Docker does not have it.

pub async fn registry_platforms( &self, image: &str, ) -> Result<Vec<String>, Error>

Asks the image’s registry for its manifest, without pulling it, and returns the platforms it is built for, such as linux/amd64. An error means pull could not get it.

Trait Implementations

impl Debug for Docker

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DockerApi for Docker

async fn start( &self, spec: &RunnerSpec, isolation: &dyn Isolation, ) -> Result<String, Error>

Creates and starts a runner container; returns its ID.

async fn inspect(&self, container: &str) -> Result<RunnerState, Error>

A container’s state and isolation.

async fn remove(&self, container: &str) -> Result<(), Error>

Removes a runner container, stopping it first if it runs.

async fn run( &self, name: &str, body: ContainerCreateBody, ) -> Result<String, Error>

Creates and starts a container that is not a runner, such as the mirror; returns its ID.

async fn list(&self, label: &str) -> Result<Vec<Container>, Error>

Every container, running or not, that has the label.

async fn wait(&self, container: &str) -> Result<i64, Error>

Waits for a container to exit; returns its exit code.

async fn logs(&self, container: &str) -> Result<String, Error>

A container’s output so far, stdout and stderr interleaved.

async fn logs_since(&self, container: &str, since: u64) -> Result<String, Error>

A container’s output since since (seconds since the epoch), each line prefixed with Docker’s RFC 3339 timestamp and a space.

async fn exec( &self, container: &str, command: Vec<String>, ) -> Result<Output, Error>

Runs a command as root in a running container; its stdout streams until it exits or the container stops. Its stderr is dropped.

async fn image_present(&self, image: &str) -> Result<bool, Error>

Whether Docker has an image.

async fn pull(&self, image: &str) -> Result<(), Error>

Pulls an image, logging its progress every few seconds.

async fn ensure_network(&self, name: &str) -> Result<(), Error>

Creates a bridge network unless it exists.

async fn ensure_volume(&self, name: &str) -> Result<(), Error>

Creates a volume unless it exists.

async fn remove_volume(&self, name: &str) -> Result<(), Error>

Removes a volume; a volume that does not exist is not an error.

async fn volume_sizes(&self) -> Result<BTreeMap<String, u64>, Error>

The disk size of every volume Docker knows, by name. Slow: Docker measures each volume.

async fn changes(&self, container: &str) -> Result<Vec<String>, Error>

The paths a container’s own layer added or changed, not those it deleted.

async fn written(&self, container: &str) -> Result<u64, Error>

The bytes a container’s own layer holds.

async fn commit( &self, container: &str, reference: &str, labels: BTreeMap<String, String>, ) -> Result<u64, Error>

Commits a stopped container’s own layer as the image reference (repository:tag) with labels; returns the disk the image takes beyond its parent.

async fn images(&self, label: &str) -> Result<Vec<Image>, Error>

Every image with the label.

async fn image_id(&self, reference: &str) -> Result<Option<String>, Error>

The ID of the image a reference (tag, digest or ID) names; None when Docker does not have it.

async fn tagged_images(&self) -> Result<Vec<TaggedImage>, Error>

Every image Docker has a tag for.

async fn container_images(&self) -> Result<BTreeSet<String>, Error>

The image ID of every container, running or stopped.

async fn remove_image(&self, reference: &str) -> Result<(), Error>

Removes an image and the layers only it used; one that does not exist is not an error.

async fn free_space(&self) -> Result<u64, Error>

The free disk where Docker keeps its images and containers.

async fn shell( &self, name: &str, body: ContainerCreateBody, size: TtySize, ) -> Result<Tty, Error>

Creates a container with a terminal of size, attaches to it and starts it. The container’s stdin closes when Tty::input is dropped.