Struct docker_api::image::Images

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

Interface for docker images

Implementations

impl<'docker> Images<'docker>

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

Exports an interface for interacting with docker images

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

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

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImageBuild

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

Lists the docker images on the current docker host

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImageList

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

Returns a reference to a set of operations available for a named image

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

Search for docker images by term

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImageSearch

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

Pull and create a new docker images from an existing image

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImagePull

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

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

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImageGetAll

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

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

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ImageLoad

Trait Implementations

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

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

Formats the value using the given formatter.