Struct docker_api::api::image::Image

pub struct Image { /* private fields */ }

Interface for accessing and manipulating Docker Image.

Api Reference

Implementations

impl Image

pub fn new(docker: Docker, name: impl Into<Id>) -> Self

Exports an interface exposing operations against a Image instance.

pub fn name(&self) -> &Id

A getter for Image name

impl Image

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

Api Reference

Inspect this Image.

pub async fn remove( &self, opts: &ImageRemoveOpts ) -> Result<Vec<ImageDeleteResponseItem>>

Api Reference

Remove this image with options.

Use delete to delete without options.

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

Api Reference

Delete this image with force.

Use remove to delete with options.

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

Api Reference

Lists the history of the images set of changes.

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

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<DistributionInspect>

Api Reference

Return image digest and platform information by contacting the registry.

Trait Implementations

impl Debug for Image

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

Formats the value using the given formatter.