Struct shiplift::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<Value>> + Unpin + 'docker

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

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

Lists the docker images on the current docker host

pub fn get<S>(&self, name: S) -> Image<'docker> where
    S: 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

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

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

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<Value>> + 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