Struct Docker 

pub struct Docker { /* private fields */ }

Docker container manager

Implementations

impl Docker

pub async fn connect() -> Result<Self, DockerError>

Create a new Docker container manager

pub async fn ping(&self) -> Result<(), DockerError>

Ping the Docker daemon

pub fn events(&self) -> impl Stream<Item = Result<EventMessage, DockerError>>

Ping the Docker daemon

Methods from Deref<Target = Client>

pub async fn list_containers( &self, options: Option<impl Into<ListContainersOptions>>, ) -> Result<Vec<ContainerSummary>, Error>

---

List Containers

Returns a list of containers.

Arguments

• Optional ListContainersOptions struct.

Returns

• Vector of ContainerSummary, wrapped in a Future.

Examples

use bollard::container::ListContainersOptions;

use std::collections::HashMap;
use std::default::Default;

let mut filters = HashMap::new();
filters.insert("health", vec!["unhealthy"]);

let options = Some(ListContainersOptions{
    all: true,
    filters,
    ..Default::default()
});

docker.list_containers(options);

pub async fn create_container( &self, options: Option<impl Into<CreateContainerOptions>>, config: impl Into<ContainerCreateBody>, ) -> Result<ContainerCreateResponse, Error>

---

Create Container

Prepares a container for a subsequent start operation.

Arguments

• Optional Create Container Options struct.
• Container Config struct.

Returns

• ContainerCreateResponse, wrapped in a Future.

Examples

use bollard::container::{CreateContainerOptions, Config};

use std::default::Default;

let options = Some(CreateContainerOptions{
    name: "my-new-container",
    platform: None,
});

let config = Config {
    image: Some("hello-world"),
    cmd: Some(vec!["/hello"]),
    ..Default::default()
};

docker.create_container(options, config);

pub async fn start_container( &self, container_name: &str, options: Option<impl Into<StartContainerOptions>>, ) -> Result<(), Error>

---

Start Container

Starts a container, after preparing it with the Create Container API.

Arguments

• Container name as a string slice.
• Optional Start Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::StartContainerOptions;

docker.start_container("hello-world", None::<StartContainerOptions<String>>);

pub async fn stop_container( &self, container_name: &str, options: Option<impl Into<StopContainerOptions>>, ) -> Result<(), Error>

---

Stop Container

Stops a container.

Arguments

• Container name as string slice.
• Optional Stop Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::StopContainerOptions;

let options = Some(StopContainerOptions{
    t: 30,
});

docker.stop_container("hello-world", options);

pub async fn remove_container( &self, container_name: &str, options: Option<impl Into<RemoveContainerOptions>>, ) -> Result<(), Error>

---

Remove Container

Remove a container.

Arguments

• Container name as a string slice.
• Optional Remove Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::RemoveContainerOptions;

use std::default::Default;

let options = Some(RemoveContainerOptions{
    force: true,
    ..Default::default()
});

docker.remove_container("hello-world", options);

pub fn wait_container( &self, container_name: &str, options: Option<impl Into<WaitContainerOptions>>, ) -> impl Stream<Item = Result<ContainerWaitResponse, Error>>

---

Wait Container

Wait for a container to stop. This is a non-blocking operation, the resulting stream will end when the container stops.

Arguments

• Container name as string slice.
• Optional Wait Container Options struct.

Returns

• ContainerWaitResponse, wrapped in a Stream.

Examples

use bollard::container::WaitContainerOptions;

let options = Some(WaitContainerOptions{
    condition: "not-running",
});

docker.wait_container("hello-world", options);

pub async fn attach_container( &self, container_name: &str, options: Option<impl Into<AttachContainerOptions>>, ) -> Result<AttachContainerResults, Error>

---

Attach Container

Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached.

Arguments

• Container name as string slice.
• Optional Attach Container Options struct.

Returns

• AttachContainerResults wrapped in a Future.

Examples

use bollard::container::AttachContainerOptions;

let options = Some(AttachContainerOptions::<String>{
    stdin: Some(true),
    stdout: Some(true),
    stderr: Some(true),
    stream: Some(true),
    logs: Some(true),
    detach_keys: Some("ctrl-c".to_string()),
});

docker.attach_container("hello-world", options);

pub async fn resize_container_tty( &self, container_name: &str, options: impl Into<ResizeContainerTTYOptions>, ) -> Result<(), Error>

---

Resize container tty

Resize the container’s TTY.

Arguments

• Container name as string slice.
• Resize Container Tty Options struct.

Examples

use bollard::container::ResizeContainerTtyOptions;

let options = ResizeContainerTtyOptions {
    width: 50,
    height: 20,
};

docker.resize_container_tty("hello-world", options);

pub async fn restart_container( &self, container_name: &str, options: Option<impl Into<RestartContainerOptions>>, ) -> Result<(), Error>

---

Restart Container

Restart a container.

Arguments

• Container name as string slice.
• Optional Restart Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::RestartContainerOptions;

let options = Some(RestartContainerOptions{
    t: 30,
});

docker.restart_container("postgres", options);

pub async fn inspect_container( &self, container_name: &str, options: Option<impl Into<InspectContainerOptions>>, ) -> Result<ContainerInspectResponse, Error>

---

Inspect Container

Inspect a container.

Arguments

• Container name as a string slice.
• Optional Inspect Container Options struct.

Returns

• ContainerInspectResponse, wrapped in a Future.

Examples

use bollard::container::InspectContainerOptions;

let options = Some(InspectContainerOptions{
    size: false,
});

docker.inspect_container("hello-world", options);

pub async fn top_processes( &self, container_name: &str, options: Option<impl Into<TopOptions>>, ) -> Result<ContainerTopResponse, Error>

---

Top Processes

List processes running inside a container.

Arguments

• Container name as string slice.
• Optional Top Options struct.

Returns

• ContainerTopResponse, wrapped in a Future.

Examples

use bollard::container::TopOptions;

let options = Some(TopOptions{
    ps_args: "aux",
});

docker.top_processes("fussybeaver/uhttpd", options);

pub fn logs( &self, container_name: &str, options: Option<impl Into<LogsOptions>>, ) -> impl Stream<Item = Result<LogOutput, Error>>

---

Logs

Get container logs.

Arguments

• Container name as string slice.
• Optional Logs Options struct.

Returns

• Log Output enum, wrapped in a Stream.

Examples

use bollard::container::LogsOptions;

use std::default::Default;

let options = Some(LogsOptions::<String>{
    stdout: true,
    ..Default::default()
});

docker.logs("hello-world", options);

pub async fn container_changes( &self, container_name: &str, ) -> Result<Option<Vec<FilesystemChange>>, Error>

---

Container Changes

Get changes on a container’s filesystem.

Arguments

• Container name as string slice.

Returns

• An Option of Vector of File System Change structs, wrapped in a Future.

Examples

docker.container_changes("hello-world");

pub fn stats( &self, container_name: &str, options: Option<impl Into<StatsOptions>>, ) -> impl Stream<Item = Result<ContainerStatsResponse, Error>>

---

Stats

Get container stats based on resource usage.

Arguments

• Container name as string slice.
• Optional Stats Options struct.

Returns

• Stats struct, wrapped in a Stream.

Examples

use bollard::container::StatsOptions;

let options = Some(StatsOptions{
    stream: false,
    one_shot: true,
});

docker.stats("hello-world", options);

pub async fn kill_container( &self, container_name: &str, options: Option<impl Into<KillContainerOptions>>, ) -> Result<(), Error>

---

Kill Container

Kill a container.

Arguments

• Container name as string slice.
• Optional Kill Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::KillContainerOptions;

let options = Some(KillContainerOptions{
    signal: "SIGINT",
});

docker.kill_container("postgres", options);

pub async fn update_container( &self, container_name: &str, config: impl Into<ContainerUpdateBody>, ) -> Result<(), Error>

---

Update Container

Update a container.

Arguments

• Container name as string slice.
• Update Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::UpdateContainerOptions;
use std::default::Default;

let config = UpdateContainerOptions::<String> {
    memory: Some(314572800),
    memory_swap: Some(314572800),
    ..Default::default()
};

docker.update_container("postgres", config);

pub async fn rename_container( &self, container_name: &str, options: impl Into<RenameContainerOptions>, ) -> Result<(), Error>

---

Rename Container

Rename a container.

Arguments

• Container name as string slice.
• Rename Container Options struct

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::RenameContainerOptions;

let required = RenameContainerOptions {
    name: "my_new_container_name"
};

docker.rename_container("hello-world", required);

pub async fn pause_container(&self, container_name: &str) -> Result<(), Error>

---

Pause Container

Use the cgroups freezer to suspend all processes in a container.

Arguments

• Container name as a string slice.

Returns

• unit type (), wrapped in a Future.

Examples

docker.pause_container("postgres");

pub async fn unpause_container(&self, container_name: &str) -> Result<(), Error>

---

Unpause Container

Resume a container which has been paused.

Arguments

• Container name as a string slice.

Returns

• unit type (), wrapped in a Future.

Examples

docker.unpause_container("postgres");

pub async fn prune_containers( &self, options: Option<impl Into<PruneContainersOptions>>, ) -> Result<ContainerPruneResponse, Error>

---

Prune Containers

Delete stopped containers.

Arguments

• Optional Prune Containers Options struct.

Returns

• Container Prune Response struct, wrapped in a Future.

Examples

use bollard::container::PruneContainersOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("until", vec!["10m"]);

let options = Some(PruneContainersOptions{
    filters
});

docker.prune_containers(options);

pub async fn upload_to_container_streaming( &self, container_name: &str, options: Option<impl Into<UploadToContainerOptions>>, tar: impl Stream<Item = Bytes> + Send + 'static, ) -> Result<(), Error>

👎Deprecated since 0.19.0:

This method is refactored into upload_to_container

---

Stream Upload To Container

Stream an upload of a tar archive to be extracted to a path in the filesystem of container id.

Arguments

• Optional Upload To Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::container::UploadToContainerOptions;
use futures_util::{StreamExt, TryFutureExt};
use tokio::fs::File;
use tokio_util::io::ReaderStream;

let options = Some(UploadToContainerOptions{
    path: "/opt",
    ..Default::default()
});

let file = File::open("tarball.tar.gz")
    .map_ok(ReaderStream::new)
    .try_flatten_stream()
    .map(|x|x.expect("failed to stream file"));

docker
    .upload_to_container_streaming("my-container", options, file)
    .await
    .expect("upload failed");

pub async fn upload_to_container( &self, container_name: &str, options: Option<impl Into<UploadToContainerOptions>>, tar: Either<Full<Bytes>, StreamBody<Pin<Box<dyn Stream<Item = Result<Frame<Bytes>, Error>> + Send>>>>, ) -> Result<(), Error>

---

Upload To Container

Upload a tar archive to be extracted to a path in the filesystem of container id.

Arguments

• Optional Upload To Container Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

Uploading a tarball

use bollard::container::UploadToContainerOptions;
use bollard::body_full;
use std::fs::File;
use std::io::Read;

let options = Some(UploadToContainerOptions{
    path: "/opt",
    ..Default::default()
});

let mut file = File::open("tarball.tar.gz").unwrap();
let mut contents = Vec::new();
file.read_to_end(&mut contents).unwrap();

docker
    .upload_to_container("my-container", options, body_full(contents.into()))
    .await
    .expect("upload failed");

Uploading a stream

use bollard::container::UploadToContainerOptions;
use bollard::body_try_stream;
use futures_util::{StreamExt, TryFutureExt};
use tokio::fs::File;
use tokio_util::io::ReaderStream;

let options = Some(UploadToContainerOptions{
    path: "/opt",
    ..Default::default()
});

let file = File::open("tarball.tar.gz")
    .map_ok(ReaderStream::new)
    .try_flatten_stream();

docker
    .upload_to_container("my-container", options, body_try_stream(file))
    .await
    .expect("upload failed");

pub fn download_from_container( &self, container_name: &str, options: Option<impl Into<DownloadFromContainerOptions>>, ) -> impl Stream<Item = Result<Bytes, Error>>

---

Download From Container

Get a tar archive of a resource in the filesystem of container id.

Arguments

• Download From Container Options struct.

Returns

• Tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. Hyper Body.

Examples

use bollard::container::DownloadFromContainerOptions;

let options = Some(DownloadFromContainerOptions{
    path: "/opt",
});

docker.download_from_container("my-container", options);

pub fn export_container( &self, container_name: &str, ) -> impl Stream<Item = Result<Bytes, Error>>

---

Export Container

Get a tarball containing the filesystem contents of a container.

See the Docker API documentation for more information.

Arguments

• The container_name string referring to an individual container

Returns

• An uncompressed TAR archive

pub fn timeout(&self) -> Duration

Get the current timeout.

This timeout is shared by all requests to the Docker Engine API.

pub fn set_timeout(&mut self, timeout: Duration)

Set the request timeout.

This timeout is shared by all requests to the Docker Engine API.

By default, 2 minutes.

pub fn client_version(&self) -> ClientVersion

Return the currently set client version.

pub async fn create_exec( &self, container_name: &str, config: impl Into<ExecConfig>, ) -> Result<CreateExecResults, Error>

---

Create Exec

Run a command inside a running container.

Arguments

• Container name as string slice.
• Create Exec Options struct.

Returns

• A Create Exec Results struct, wrapped in a Future.

Examples

use bollard::exec::CreateExecOptions;

use std::default::Default;

let config = CreateExecOptions {
    cmd: Some(vec!["ps", "-ef"]),
    attach_stdout: Some(true),
    ..Default::default()
};

docker.create_exec("hello-world", config);

pub async fn start_exec( &self, exec_id: &str, config: Option<StartExecOptions>, ) -> Result<StartExecResults, Error>

---

Start Exec

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command.

Arguments

• The ID of the previously created exec configuration.

Returns

• Log Output enum, wrapped in a Stream.

Examples

async {
    let message = docker.create_exec("hello-world", config).await.unwrap();
    use bollard::exec::StartExecOptions;
    docker.start_exec(&message.id, None::<StartExecOptions>);
};

pub async fn inspect_exec( &self, exec_id: &str, ) -> Result<ExecInspectResponse, Error>

---

Inspect Exec

Return low-level information about an exec instance.

Arguments

• The ID of the previously created exec configuration.

Returns

• An Exec Inspect Response struct, wrapped in a Future.

Examples

async {
    let message = docker.create_exec("hello-world", config).await.unwrap();
    docker.inspect_exec(&message.id);
};

pub async fn resize_exec( &self, exec_id: &str, options: impl Into<ResizeExecOptions>, ) -> Result<(), Error>

---

Resize Exec

Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Arguments

• The ID of the previously created exec configuration.
• Resize Exec Options struct.

Examples

async {
    let message = docker.create_exec("hello-world", config).await.unwrap();
    docker.resize_exec(&message.id, ResizeExecOptions {
        width: 80,
        height: 60
    });
};

pub async fn list_images( &self, options: Option<impl Into<ListImagesOptions>>, ) -> Result<Vec<ImageSummary>, Error>

---

List Images

Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image

Arguments

• An optional List Images Options struct.

Returns

• Vector of API Images, wrapped in a Future.

Examples

use bollard::image::ListImagesOptions;

use std::collections::HashMap;
use std::default::Default;

let mut filters = HashMap::new();
filters.insert("dangling", vec!["true"]);

let options = Some(ListImagesOptions{
  all: true,
  filters,
  ..Default::default()
});

docker.list_images(options);

pub fn create_image( &self, options: Option<impl Into<CreateImageOptions>>, root_fs: Option<Either<Full<Bytes>, StreamBody<Pin<Box<dyn Stream<Item = Result<Frame<Bytes>, Error>> + Send>>>>>, credentials: Option<DockerCredentials>, ) -> impl Stream<Item = Result<CreateImageInfo, Error>>

---

Create Image

Create an image by either pulling it from a registry or importing it.

Arguments

• An optional Create Image Options struct.
• An optional request body consisting of a tar or tar.gz archive, or a stream containing the root file system for the image. If this argument is used, the value of the from_src option must be “-”.

Returns

• Create Image Info, wrapped in an asynchronous Stream.

Examples

use bollard::image::CreateImageOptions;

use std::default::Default;

let options = Some(CreateImageOptions{
  from_image: "hello-world",
  ..Default::default()
});

docker.create_image(options, None, None);

// do some other work while the image is pulled from the docker hub...

Unsupported

• Import from tarball

pub async fn inspect_image( &self, image_name: &str, ) -> Result<ImageInspect, Error>

---

Inspect Image

Return low-level information about an image.

Arguments

• Image name as a string slice.

Returns

• ImageInspect, wrapped in a Future.

Examples

use std::default::Default;

docker.inspect_image("hello-world");

pub async fn inspect_registry_image( &self, image_name: &str, credentials: Option<DockerCredentials>, ) -> Result<DistributionInspect, Error>

---

Inspect an Image by contacting the registry

Return image digest and platform information by contacting the registry

Arguments

• Image name as a string slice.

Returns

• DistributionInspect, wrapped in a Future

Examples

use bollard::Docker;
let docker = Docker::connect_with_http_defaults().unwrap();
docker.inspect_registry_image("ubuntu:jammy", None);

pub async fn prune_images( &self, options: Option<impl Into<PruneImagesOptions>>, ) -> Result<ImagePruneResponse, Error>

---

Prune Images

Delete unused images.

Arguments

• An optional Prune Images Options struct.

Returns

• a Prune Image Response, wrapped in a Future.

Examples

use bollard::image::PruneImagesOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("until", vec!["10m"]);

let options = Some(PruneImagesOptions {
  filters
});

docker.prune_images(options);

pub async fn image_history( &self, image_name: &str, ) -> Result<Vec<HistoryResponseItem>, Error>

---

Image History

Return parent layers of an image.

Arguments

• Image name as a string slice.

Returns

• Vector of History Response Item, wrapped in a Future.

Examples

docker.image_history("hello-world");

pub async fn search_images( &self, options: impl Into<SearchImagesOptions>, ) -> Result<Vec<ImageSearchResponseItem>, Error>

---

Search Images

Search for an image on Docker Hub.

Arguments

• Search Image Options struct.

Returns

• Vector of Image Search Response Item results, wrapped in a Future.

Examples

use bollard::image::SearchImagesOptions;
use std::default::Default;
use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("until", vec!["10m"]);

let search_options = SearchImagesOptions {
    term: "hello-world",
    filters,
    ..Default::default()
};

docker.search_images(search_options);

pub async fn remove_image( &self, image_name: &str, options: Option<impl Into<RemoveImageOptions>>, credentials: Option<DockerCredentials>, ) -> Result<Vec<ImageDeleteResponseItem>, Error>

---

Remove Image

Remove an image, along with any untagged parent images that were referenced by that image.

Arguments

• Image name as a string slice.
• An optional Remove Image Options struct.

Returns

• Vector of Image Delete Response Item, wrapped in a Future.

Examples

use bollard::image::RemoveImageOptions;
use std::default::Default;

let remove_options = Some(RemoveImageOptions {
    force: true,
    ..Default::default()
});

docker.remove_image("hello-world", remove_options, None);

pub async fn tag_image( &self, image_name: &str, options: Option<impl Into<TagImageOptions>>, ) -> Result<(), Error>

---

Tag Image

Tag an image so that it becomes part of a repository.

Arguments

• Image name as a string slice.
• Optional Tag Image Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::image::TagImageOptions;
use std::default::Default;

let tag_options = Some(TagImageOptions {
    tag: "v1.0.1",
    ..Default::default()
});

docker.tag_image("hello-world", tag_options);

pub fn push_image( &self, image_name: &str, options: Option<impl Into<PushImageOptions>>, credentials: Option<DockerCredentials>, ) -> impl Stream<Item = Result<PushImageInfo, Error>>

---

Push Image

Push an image to a registry.

Arguments

• Image name as a string slice.
• Optional Push Image Options struct.
• Optional Docker Credentials struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::auth::DockerCredentials;
use bollard::image::PushImageOptions;

use std::default::Default;

let push_options = Some(PushImageOptions {
    tag: "v1.0.1",
});

let credentials = Some(DockerCredentials {
    username: Some("Jack".to_string()),
    password: Some("myverysecretpassword".to_string()),
    ..Default::default()
});

docker.push_image("hello-world", push_options, credentials);

pub async fn commit_container( &self, options: impl Into<CommitContainerOptions>, config: impl Into<ContainerConfig>, ) -> Result<IdResponse, Error>

---

Commit Container

Create a new image from a container.

Arguments

• Commit Container Options struct.
• Container Config struct.

Returns

• Commit, wrapped in a Future.

Examples

use bollard::image::CommitContainerOptions;
use bollard::container::Config;

use std::default::Default;

let options = CommitContainerOptions{
    container: "my-running-container",
    pause: true,
    ..Default::default()
};

let config = Config::<String> {
    ..Default::default()
};

docker.commit_container(options, config);

pub fn build_image( &self, options: impl Into<BuildImageOptions>, credentials: Option<HashMap<String, DockerCredentials>>, tar: Option<Either<Full<Bytes>, StreamBody<Pin<Box<dyn Stream<Item = Result<Frame<Bytes>, Error>> + Send>>>>>, ) -> impl Stream<Item = Result<BuildInfo, Error>>

---

Build Image

Build an image from a tar archive with a Dockerfile in it.

The Dockerfile specifies how the image is built from the tar archive. It is typically in the archive’s root, but can be at a different path or have a different name by specifying the dockerfile parameter.

By default, the call to build specifies using BuilderV1, the first generation builder in docker daemon.

Arguments

• Build Image Options struct.
• Optional Docker Credentials struct.
• Tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. Optional Hyper Body.

Returns

• Create Image Info, wrapped in an asynchronous Stream.

Examples

Sending a tarball:

use bollard::image::BuildImageOptions;
use bollard::container::Config;
use bollard::body_full;

use std::default::Default;
use std::fs::File;
use std::io::Read;

let options = BuildImageOptions{
    dockerfile: "Dockerfile",
    t: "my-image",
    rm: true,
    ..Default::default()
};

let mut file = File::open("tarball.tar.gz").unwrap();
let mut contents = Vec::new();
file.read_to_end(&mut contents).unwrap();

docker.build_image(options, None, Some(body_full(contents.into())));

Sending a stream:

use bollard::image::BuildImageOptions;
use bollard::container::Config;
use bollard::body_stream;

use std::default::Default;
use std::fs::File;
use std::io::Read;

let options = BuildImageOptions{
    dockerfile: "Dockerfile",
    t: "my-image",
    rm: true,
    ..Default::default()
};


docker.build_image(options, None, Some(body_stream(stream)));

pub async fn prune_build( &self, options: Option<impl Into<PruneBuildOptions>>, ) -> Result<BuildPruneResponse, Error>

---

Prune Build

Delete contents of the build cache

Arguments

• An optional Prune Build Options struct.

Returns

• a Prune Build Response, wrapped in a Future.

Examples

use bollard::image::PruneBuildOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("until", vec!["10m"]);

let options = Some(PruneBuildOptions {
  filters,
  ..Default::default()
});

docker.prune_build(options);

pub fn export_image( &self, image_name: &str, ) -> impl Stream<Item = Result<Bytes, Error>>

---

Export Image

Get a tarball containing all images and metadata for a repository.

The root of the resulting tar file will contain the file “manifest.json”. If the export is of an image repository, rather than a single image, there will also be a repositories file with a JSON description of the exported image repositories. Additionally, each layer of all exported images will have a sub directory in the archive containing the filesystem of the layer.

See the Docker API documentation for more information.

Arguments

• The image_name string referring to an individual image and tag (e.g. alpine:latest)

Returns

• An uncompressed TAR archive

pub fn export_images( &self, image_names: &[&str], ) -> impl Stream<Item = Result<Bytes, Error>>

---

Export Images

Get a tarball containing all images and metadata for several image repositories. Shared layers will be deduplicated.

See the Docker API documentation for more information.

Arguments

• The image_names Vec of image names.

Returns

• An uncompressed TAR archive

pub fn import_image( &self, options: impl Into<ImportImageOptions>, root_fs: Either<Full<Bytes>, StreamBody<Pin<Box<dyn Stream<Item = Result<Frame<Bytes>, Error>> + Send>>>>, credentials: Option<HashMap<String, DockerCredentials>>, ) -> impl Stream<Item = Result<BuildInfo, Error>>

---

Import Image

Load a set of images and tags into a repository.

For details on the format, see the export image endpoint.

Arguments

• Image Import Options struct.

Returns

• Build Info, wrapped in an asynchronous Stream.

Examples

use bollard::image::ImportImageOptions;
use bollard::errors::Error;
use bollard::body_full;

use std::default::Default;
use futures_util::stream::{StreamExt, TryStreamExt};
use tokio::fs::File;
use tokio::io::AsyncWriteExt;
use tokio_util::codec;

let options = ImportImageOptions{
    ..Default::default()
};

async move {
    let mut file = File::open("tarball.tar.gz").await.unwrap();

    let mut byte_stream = codec::FramedRead::new(file, codec::BytesCodec::new()).map(|r| {
        let bytes = r.unwrap().freeze();
        Ok::<_, Error>(bytes)
    });

    let bytes = byte_stream.next().await.unwrap().unwrap();

    let mut stream = docker
        .import_image(
            ImportImageOptions {
                ..Default::default()
            },
            body_full(bytes),
            None,
        );

    while let Some(response) = stream.next().await {
        // ...
    }
};

pub fn import_image_stream( &self, options: impl Into<ImportImageOptions>, root_fs: impl Stream<Item = Bytes> + Send + 'static, credentials: Option<HashMap<String, DockerCredentials>>, ) -> impl Stream<Item = Result<BuildInfo, Error>>

---

Import Image (stream)

Load a set of images and tags into a repository, without holding it all in memory at a given point in time

For details on the format, see the export image endpoint.

Arguments

• Image Import Options struct.
• Stream producing Bytes of the image

Returns

• Build Info, wrapped in an asynchronous Stream.

Examples

use bollard::image::ImportImageOptions;
use bollard::errors::Error;

use std::default::Default;
use futures_util::stream::{StreamExt, TryStreamExt};
use tokio::fs::File;
use tokio::io::AsyncWriteExt;
use tokio_util::codec;

let options = ImportImageOptions{
    ..Default::default()
};

async move {
    let mut file = File::open("tarball.tar.gz").await.unwrap();

    let mut byte_stream = codec::FramedRead::new(file, codec::BytesCodec::new()).map(|r| {
        r.unwrap().freeze()
    });

    let mut stream = docker
        .import_image_stream(
            ImportImageOptions {
                ..Default::default()
            },
            byte_stream,
            None,
        );

    while let Some(response) = stream.next().await {
        // ...
    }
};

pub async fn create_network( &self, config: impl Into<NetworkCreateRequest>, ) -> Result<NetworkCreateResponse, Error>

---

Create Network

Create a new network.

Arguments

• Create Network Options struct.

Returns

• A Network Create Response struct, wrapped in a Future.

Examples

use bollard::network::CreateNetworkOptions;

use std::default::Default;

let config = CreateNetworkOptions {
    name: "certs",
    ..Default::default()
};

docker.create_network(config);

pub async fn remove_network(&self, network_name: &str) -> Result<(), Error>

---

Remove a Network

Arguments

• Network name as a string slice.

Returns

• unit type (), wrapped in a Future.

Examples

docker.remove_network("my_network_name");

pub async fn inspect_network( &self, network_name: &str, options: Option<impl Into<InspectNetworkOptions>>, ) -> Result<Network, Error>

---

Inspect a Network

Arguments

• Network name as a string slice.

Returns

• A Models struct, wrapped in a Future.

Examples

use bollard::network::InspectNetworkOptions;

use std::default::Default;

let config = InspectNetworkOptions {
    verbose: true,
    scope: "global"
};

docker.inspect_network("my_network_name", Some(config));

pub async fn list_networks( &self, options: Option<impl Into<ListNetworksOptions>>, ) -> Result<Vec<Network>, Error>

---

List Networks

Arguments

• Optional List Network Options struct.

Returns

• A vector of Network struct, wrapped in a Future.

Examples

use bollard::network::ListNetworksOptions;

use std::collections::HashMap;

let mut list_networks_filters = HashMap::new();
list_networks_filters.insert("label", vec!["maintainer=some_maintainer"]);

let config = ListNetworksOptions {
    filters: list_networks_filters,
};

docker.list_networks(Some(config));

pub async fn connect_network( &self, network_name: &str, config: impl Into<NetworkConnectRequest>, ) -> Result<(), Error>

---

Connect Network

Arguments

• A Connect Network Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::network::ConnectNetworkOptions;
use bollard::models::{EndpointSettings, EndpointIpamConfig};

use std::default::Default;

let config = ConnectNetworkOptions {
    container: "3613f73ba0e4",
    endpoint_config: EndpointSettings {
        ipam_config: Some(EndpointIpamConfig {
            ipv4_address: Some(String::from("172.24.56.89")),
            ipv6_address: Some(String::from("2001:db8::5689")),
            ..Default::default()
        }),
        ..Default::default()
    }
};

docker.connect_network("my_network_name", config);

pub async fn disconnect_network( &self, network_name: &str, config: impl Into<NetworkDisconnectRequest>, ) -> Result<(), Error>

---

Disconnect Network

Arguments

• A Disconnect Network Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::network::DisconnectNetworkOptions;

use std::default::Default;

let config = DisconnectNetworkOptions {
    container: "3613f73ba0e4",
    force: true
};

docker.disconnect_network("my_network_name", config);

pub async fn prune_networks( &self, options: Option<impl Into<PruneNetworksOptions>>, ) -> Result<NetworkPruneResponse, Error>

---

Prune Networks

Deletes networks which are unused.

Arguments

• A Prune Networks Options struct.

Returns

• A Network Prune Response struct.

Examples

use bollard::network::PruneNetworksOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("label", vec!["maintainer=some_maintainer"]);

let options = PruneNetworksOptions {
    filters,
};

docker.prune_networks(Some(options));

pub async fn list_nodes( &self, options: Option<impl Into<ListNodesOptions>>, ) -> Result<Vec<Node>, Error>

---

List Nodes

Arguments

• Optional List Nodes Options struct.

Returns

• A vector of Node struct, wrapped in a Future.

Examples

use bollard::node::ListNodesOptions;

use std::collections::HashMap;

let mut list_nodes_filters = HashMap::new();
list_nodes_filters.insert("node.label", vec!["my-node-label"]);

let config = ListNodesOptions {
    filters: list_nodes_filters,
};

docker.list_nodes(Some(config));

pub async fn inspect_node(&self, node_name: &str) -> Result<Node, Error>

---

Inspect a Node

Arguments

• Node id or name as a string slice.

Returns

• A Models struct, wrapped in a Future.

Examples

docker.inspect_node("my_node_name");

pub async fn delete_node( &self, node_name: &str, options: Option<impl Into<DeleteNodeOptions>>, ) -> Result<(), Error>

---

Delete Node

Delete a node.

Arguments

• Node id or name as a string slice.
• Optional Delete Node Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::node::DeleteNodeOptions;

let options = Some(DeleteNodeOptions {
    force: true,
    ..Default::default()
});

docker.delete_node("my-node", options);

pub async fn update_node( &self, node_id: &str, spec: NodeSpec, options: impl Into<UpdateNodeOptions>, ) -> Result<(), Error>

---

Update Node

Update a node.

Arguments

• Node id as string slice.
• Update Node Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::node::UpdateNodeOptions;
use bollard::models::{NodeSpec, NodeSpecAvailabilityEnum, NodeSpecRoleEnum};

let spec = NodeSpec {
    availability: Some(NodeSpecAvailabilityEnum::ACTIVE),
    name: Some("my-new-node-name".to_string()),
    role: Some(NodeSpecRoleEnum::MANAGER),
    ..Default::default()
};

let options = UpdateNodeOptions {
    version: 2,
    ..Default::default()
};

docker.update_node("my-node-id", spec, options);

pub async fn list_secrets( &self, options: Option<impl Into<ListSecretsOptions>>, ) -> Result<Vec<Secret>, Error>

---

List Secrets

Returns a list of secrets.

Arguments

• Optional ListSecretsOptions struct.

Returns

• Vector of Secret, wrapped in a Future.

Examples

use bollard::secret::ListSecretsOptions;

use std::collections::HashMap;
use std::default::Default;

let mut filters = HashMap::new();
filters.insert("label", vec!["secret-label=label-value"]);

let options = Some(ListSecretsOptions{
    filters,
    ..Default::default()
});

docker.list_secrets(options);

pub async fn create_secret( &self, secret_spec: SecretSpec, ) -> Result<IdResponse, Error>

---

Create Secret

Create new secret on the docker swarm.

Arguments

• SecretSpec struct.

Returns

• A IdResponse wrapped in a Future.

Examples

use bollard::secret::SecretSpec;

use base64;

let secret_spec = SecretSpec {
    name: Some(String::from("secret-name")),
    data: Some(base64::engine::general_purpose::STANDARD.encode("secret-data")),
    ..Default::default()
};

docker.create_secret(secret_spec);

pub async fn inspect_secret(&self, secret_id: &str) -> Result<Secret, Error>

---

Inspect Secret

Inspect a secret.

Arguments

• Secret id or name as a string slice.

Returns

• Secret, wrapped in a Future.

Examples

docker.inspect_secret("secret-id");
docker.inspect_secret("secret-name");

pub async fn delete_secret(&self, secret_id: &str) -> Result<(), Error>

---

Delete Secret

Delete a secret, fails when more than one service use that secret..

Arguments

• Secret id or name as a string slice.

Returns

• unit type (), wrapped in a Future.

Examples

docker.delete_secret("secret-id");
docker.delete_secret("secret-name");

pub async fn update_secret( &self, secret_id: &str, secret_spec: SecretSpec, options: impl Into<UpdateSecretOptions>, ) -> Result<(), Error>

---

Update Secret

Update an existing secret, fails when more than one service use that secret or trying update data.

Arguments

• Secret id or name as a string slice.
• SecretSpec struct.
• UpdateSecretOptions struct.

Returns

• unit type (), wrapped in a Future.

Examples

use std::collections::HashMap;
use bollard::secret::UpdateSecretOptions;

let result = async move {
    let existing = docker.inspect_secret("my-secret").await?;
    let version = existing.version.unwrap().index.unwrap();
    let mut spec = existing.spec.unwrap().clone();

    let mut labels = HashMap::new();
    labels.insert(String::from("secret-label"), String::from("label-value"));
    spec.labels = Some(labels.clone());

    let options = UpdateSecretOptions { version };

    docker.update_secret("my-secret", spec, options).await
};

pub async fn list_services( &self, options: Option<impl Into<ListServicesOptions>>, ) -> Result<Vec<Service>, Error>

---

List Services

Returns a list of services.

Arguments

• Optional ListServicesOptions struct.

Returns

• Vector of Services, wrapped in a Future.

Examples

use bollard::service::ListServicesOptions;

use std::collections::HashMap;
use std::default::Default;

let mut filters = HashMap::new();
filters.insert("mode", vec!["global"]);

let options = Some(ListServicesOptions{
    filters,
    ..Default::default()
});

docker.list_services(options);

pub async fn create_service( &self, service_spec: ServiceSpec, credentials: Option<DockerCredentials>, ) -> Result<ServiceCreateResponse, Error>

---

Create Service

Dispatch a new service on the docker swarm

Arguments

• ServiceSpec struct.
• Optional Docker Credentials struct.

Returns

• A Service Create Response struct, wrapped in a Future.

Examples

use bollard::service::{
    ServiceSpec,
    ServiceSpecMode,
    ServiceSpecModeReplicated,
    TaskSpec,
    TaskSpecContainerSpec
};

let service = ServiceSpec {
    name: Some(String::from("my-service")),
    mode: Some(ServiceSpecMode {
        replicated: Some(ServiceSpecModeReplicated {
            replicas: Some(2)
        }),
        ..Default::default()
    }),
    task_template: Some(TaskSpec {
        container_spec: Some(TaskSpecContainerSpec {
            image: Some(String::from("hello-world")),
            ..Default::default()
        }),
        ..Default::default()
    }),
    ..Default::default()
};
let credentials = None;

docker.create_service(service, credentials);

pub async fn inspect_service( &self, service_name: &str, options: Option<impl Into<InspectServiceOptions>>, ) -> Result<Service, Error>

---

Inspect Service

Inspect a service.

Arguments

• Service name or id as a string slice.
• Optional Inspect Service Options struct.

Returns

• Service, wrapped in a Future.

Examples

use bollard::service::InspectServiceOptions;

let options = Some(InspectServiceOptions{
    insert_defaults: true,
});

docker.inspect_service("my-service", options);

pub async fn delete_service(&self, service_name: &str) -> Result<(), Error>

---

Delete Service

Delete a service.

Arguments

• Service name or id as a string slice.

Returns

• unit type (), wrapped in a Future.

Examples

docker.delete_service("my-service");

pub async fn update_service( &self, service_name: &str, service_spec: ServiceSpec, options: impl Into<UpdateServiceOptions>, credentials: Option<DockerCredentials>, ) -> Result<ServiceUpdateResponse, Error>

---

Update Service

Update an existing service

Arguments

• Service name or id as a string slice.
• ServiceSpec struct.
• UpdateServiceOptions struct.
• Optional Docker Credentials struct.

Returns

• A Service Update Response struct, wrapped in a Future.

Examples

use bollard::service::{
    InspectServiceOptions,
    ServiceSpec,
    ServiceSpecMode,
    ServiceSpecModeReplicated,
    TaskSpec,
    TaskSpecContainerSpec,
    UpdateServiceOptions,
};

use std::collections::HashMap;
use std::default::Default;

let result = async move {
    let service_name = "my-service";
    let current_version = docker.inspect_service(
        service_name,
        None::<InspectServiceOptions>
    ).await?.version.unwrap().index.unwrap();
    let service = ServiceSpec {
        mode: Some(ServiceSpecMode {
            replicated: Some(ServiceSpecModeReplicated {
                replicas: Some(0)
            }),
            ..Default::default()
        }),
        ..Default::default()
    };
    let options = UpdateServiceOptions {
        version: current_version,
        ..Default::default()
    };
    let credentials = None;

    docker.update_service("my-service", service, options, credentials).await
};

pub async fn init_swarm( &self, config: impl Into<SwarmInitRequest>, ) -> Result<String, Error>

---

Init Swarm

Initialize a new swarm.

Arguments

• Init Swarm Options struct.

Returns

• A String wrapped in a Future.

Examples

use std::default::Default;

let config = InitSwarmOptions {
    advertise_addr: "127.0.0.1",
    listen_addr: "0.0.0.0:2377"
};

docker.init_swarm(config);

pub async fn inspect_swarm(&self) -> Result<Swarm, Error>

---

Inspect Swarm

Inspect swarm.

Arguments

Returns

• Swarm struct, wrapped in a Future.

Examples

docker.inspect_swarm();

pub async fn join_swarm( &self, config: impl Into<SwarmJoinRequest>, ) -> Result<(), Error>

---

Join a Swarm

Arguments

• Join Swarm Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

let config = JoinSwarmOptions {
    advertise_addr: "127.0.0.1",
    join_token: "token",
};
docker.join_swarm(config);

pub async fn leave_swarm( &self, options: Option<impl Into<LeaveSwarmOptions>>, ) -> Result<(), Error>

---

Leave a Swarm

Arguments

Returns

• unit type (), wrapped in a Future.

Examples

docker.leave_swarm(None::<LeaveSwarmOptions>);

pub async fn version(&self) -> Result<SystemVersion, Error>

---

Version

Returns the version of Docker that is running and various information about the system that Docker is running on.

Returns

• Version, wrapped in a Future.

Examples

docker.version();

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

---

Info

Returns Docker client and server information that is running.

Returns

• Info, wrapped in a Future.

Examples

docker.info();

pub async fn ping(&self) -> Result<String, Error>

---

Ping

This is a dummy endpoint you can use to test if the server is accessible.

Returns - A String, wrapped in a Future. # Examples

docker.ping();

pub fn events( &self, options: Option<impl Into<EventsOptions>>, ) -> impl Stream<Item = Result<EventMessage, Error>>

---

Events

Stream real-time events from the server.

Returns

• EventMessage, wrapped in a Stream.

Examples

use bollard::system::EventsOptions;
use time::{Duration, OffsetDateTime};
use std::collections::HashMap;


docker.events(Some(EventsOptions::<String> {
    since: Some(OffsetDateTime::now_utc() - Duration::minutes(20)),
    until: Some(OffsetDateTime::now_utc()),
    filters: HashMap::new(),
}));

pub async fn df( &self, options: Option<DataUsageOptions>, ) -> Result<SystemDataUsageResponse, Error>

---

Get data usage information

Show docker disk usage

Returns

• System Data Usage Response, wrapped in a Future.

Examples

docker.df(None::<DataUsageOptions>);

pub async fn list_tasks( &self, options: Option<impl Into<ListTasksOptions>>, ) -> Result<Vec<Task>, Error>

---

List Tasks

Arguments

• Optional List Tasks Options struct.

Returns

• A vector of Task struct, wrapped in a Future.

Examples

use bollard::task::ListTasksOptions;

use std::collections::HashMap;

let mut list_tasks_filters = HashMap::new();
list_tasks_filters.insert("label", vec!["my-task-label"]);

let config = ListTasksOptions {
    filters: list_tasks_filters,
};

docker.list_tasks(Some(config));

pub async fn inspect_task(&self, task_id: &str) -> Result<Task, Error>

---

Inspect a Task

Arguments

• Task id as a string slice.

Returns

• A Models struct, wrapped in a Future.

Examples

docker.inspect_task("my_task_id");

pub async fn list_volumes( &self, options: Option<impl Into<ListVolumesOptions>>, ) -> Result<VolumeListResponse, Error>

---

List volumes

Arguments

• List Volumes Options struct.

Returns

• A [Volume List Response]VolumeListResponse) struct, wrapped in a Future.

Examples

use bollard::volume::ListVolumesOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("dangling", vec!("1"));

let options = ListVolumesOptions {
    filters,
};

docker.list_volumes(Some(options));

pub async fn create_volume( &self, config: impl Into<VolumeCreateOptions>, ) -> Result<Volume, Error>

---

Create Volume

Create a new volume.

Arguments

• Create Volume Options struct.

Returns

• A Volume struct, wrapped in a Future.

Examples

use bollard::volume::CreateVolumeOptions;

use std::default::Default;

let config = CreateVolumeOptions {
    name: "certs",
    ..Default::default()
};

docker.create_volume(config);

pub async fn inspect_volume(&self, volume_name: &str) -> Result<Volume, Error>

---

Inspect a Volume

Arguments

• Volume name as a string slice.

Returns

• A Volume struct, wrapped in a Future.

Examples

docker.inspect_volume("my_volume_name");

pub async fn remove_volume( &self, volume_name: &str, options: Option<impl Into<RemoveVolumeOptions>>, ) -> Result<(), Error>

---

Remove a Volume

Arguments

• Volume name as a string slice.

Arguments

• Remove Volume Options struct.

Returns

• unit type (), wrapped in a Future.

Examples

use bollard::volume::RemoveVolumeOptions;

let options = RemoveVolumeOptions {
    force: true,
};

docker.remove_volume("my_volume_name", Some(options));

pub async fn prune_volumes( &self, options: Option<impl Into<PruneVolumesOptions>>, ) -> Result<VolumePruneResponse, Error>

---

Prune Volumes

Delete unused volumes.

Arguments

• A Prune Volumes Options struct.

Returns

• A Volume Prune Response struct.

Examples

use bollard::volume::PruneVolumesOptions;

use std::collections::HashMap;

let mut filters = HashMap::new();
filters.insert("label", vec!["maintainer=some_maintainer"]);

let options = PruneVolumesOptions {
    filters,
};

docker.prune_volumes(Some(options));

Trait Implementations

impl Borrow<Docker> for Docker

fn borrow(&self) -> &Client

Immutably borrows from an owned value.

impl BorrowMut<Docker> for Docker

fn borrow_mut(&mut self) -> &mut Client

Mutably borrows from an owned value.

impl Clone for Docker

fn clone(&self) -> Docker

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Docker

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

Formats the value using the given formatter.

impl Deref for Docker

type Target = Docker

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Docker

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Docker> for Docker

fn from(client: Client) -> Self

Converts to this type from the input type.