Struct docker_api::api::image::Image

source · [−]

pub struct Image { /* private fields */ }

Expand description

Interface for accessing and manipulating Docker Image.

Api Reference

Implementations

source

impl Image

source

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

Exports an interface exposing operations against a Image instance.

source

pub fn name(&self) -> &Id

A getter for Image name

source

impl Image

source

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

Api Reference

Inspect this Image.

source

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

Api Reference

Remove this image with options.

Use delete to delete without options.

source

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

Api Reference

Delete this image with force.

Use remove to delete with options.

source

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

Api Reference

Lists the history of the images set of changes.

source

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

Api Reference

Export this image to a tarball.

source

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

Api Reference

Adds a tag to an image.

source

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

Api Reference

Push an image to registry.

source

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

Api Reference

Return image digest and platform information by contacting the registry.

Trait Implementations

source

impl Debug for Image

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Image

impl Send for Image

impl Sync for Image

impl Unpin for Image

impl !UnwindSafe for Image

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct docker_api::api::image::Image

Implementations

impl Image

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

pub fn name(&self) -> &Id

impl Image

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

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

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

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

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

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

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

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

Trait Implementations

impl Debug for Image

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

Auto Trait Implementations

impl !RefUnwindSafe for Image

impl Send for Image

impl Sync for Image

impl Unpin for Image

impl !UnwindSafe for Image

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,