Struct docker_api::api::image::Image

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

Interface for accessing and manipulating Docker Image.

Api Reference

Implementations

impl<'docker> Image<'docker>

pub fn new<ID>(docker: &'docker Docker, name: ID) -> Self where
    ID: Into<ImageId>, 

Exports an interface exposing operations against a Image instance.

pub fn name(&self) -> ImageIdRef<'_>

A getter for Image name

impl<'docker> Image<'docker>

pub async fn inspect(&self) -> Result<ImageDetails>

Api Reference

Inspect this Image.

pub async fn remove(&self, opts: &RmImageOpts) -> Result<DeleteStatus>

Api Reference

Delete this Image. Use delete to delete without options.

pub async fn delete(&self) -> Result<DeleteStatus>

Api Reference

Delete this Image. Use remove to customize options.

pub async fn history(&self) -> Result<Vec<History>>

Api Reference

Lists the history of the images set of changes.

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

Api Reference

Export this image to a tarball.

pub async fn tag(&self, opts: &TagOpts) -> Result<()>

Api Reference

Adds a tag to an image.

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

Api Reference

Push an image to registry.

pub async fn distribution_inspect(&self) -> Result<DistributionInspectInfo>

Api Reference

Return image digest and platform information by contacting the registry.

Trait Implementations

impl<'docker> Debug for Image<'docker>

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

Formats the value using the given formatter.