Struct docker_api::api::image::Images

pub struct Images { /* private fields */ }

Interface for Docker Images.Image>

Implementations

impl Images

pub fn new(docker: Docker) -> Self

Exports an interface for interacting with Docker Images.

pub fn get(&self, name: impl Into<Id>) -> Image

Returns a reference to a set of operations available to a specific Image.

impl Images

pub async fn list(&self, opts: &ImageListOpts) -> Result<Vec<ImageSummary>>

Api Reference

List available Images.

pub async fn prune( &self, opts: &ImagePruneOpts ) -> Result<ImagePrune200Response>

Api Reference

Delete stopped/unused Images.

pub fn build<'docker>( &'docker self, opts: &ImageBuildOpts ) -> impl Stream<Item = Result<ImageBuildChunk>> + Unpin + 'docker

Api Reference

Builds a new image by reading a Dockerfile in a target directory. If speed is important consider using Image::build_par that utilizes parallel compression on big directories, to use it enable par-compression feature.

pub fn build_par<'docker>( &'docker self, opts: &ImageBuildOpts ) -> impl Stream<Item = Result<ImageBuildChunk>> + Unpin + 'docker

Api Reference

Builds a new image by reading a Dockerfile in a target directory. Uses parallel compression algorithm to speed up the execution. For a single-threaded version check Image::build.

pub async fn search<T>(&self, term: T) -> Result<ImageSearch200Response>where T: AsRef<str>,

Api Reference

Search for docker images by term.

pub fn pull<'docker>( &'docker self, opts: &PullOpts ) -> impl Stream<Item = Result<ImageBuildChunk>> + Unpin + 'docker

Api Reference

Pull and create a new docker images from an existing image.

pub fn export<'docker>( &'docker self, names: Vec<&str> ) -> impl Stream<Item = Result<Vec<u8>>> + 'docker

Api Reference

Exports a collection of named images, either by name, name:tag, or image id, into a tarball.

pub fn import<'docker, R>( &'docker self, tarball: R ) -> impl Stream<Item = Result<ImageBuildChunk>> + Unpin + 'dockerwhere R: Read + Send + 'docker,

Api Reference

Imports an image or set of images from a given tarball source. Source can be uncompressed on compressed via gzip, bzip2 or xz.

pub async fn push( &self, name: impl Into<Id>, opts: &ImagePushOpts ) -> Result<()>

Api Reference

Push an image to registry.

pub async fn clear_cache( &self, opts: &ClearCacheOpts ) -> Result<BuildPrune200Response>

Api Reference

Clear image build cache.

Trait Implementations

impl Debug for Images

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

Formats the value using the given formatter.