Struct docker_api::api::image::Images

pub struct Images<'docker> { /* fields omitted */ }

Interface for Docker Images.Image>

Implementations

impl<'docker> Images<'docker>

pub fn new(docker: &'docker Docker) -> Self

Exports an interface for interacting with Docker Images.

pub fn get<N>(&self, name: N) -> Image<'docker> where
    N: Into<String>, 

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

impl<'docker> Images<'docker>

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

Api Reference

List available Images.

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

Api Reference

Delete stopped/unused Images.

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

Api Reference

Builds a new image build by reading a Dockerfile in a target directory.

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

Api Reference

Search for docker images by term.

pub fn pull(
    &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(
    &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<R>(
    self,
    tarball: R
) -> impl Stream<Item = Result<ImageBuildChunk>> + Unpin + 'docker where
    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 clear_cache(&self, opts: &ClearCacheOpts) -> Result<ClearCacheInfo>

Trait Implementations

impl<'docker> Debug for Images<'docker>

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

Formats the value using the given formatter.