diff options
Diffstat (limited to 'src/image.rs')
| -rw-r--r-- | src/image.rs | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/src/image.rs b/src/image.rs index 45b24af..e69f85a 100644 --- a/src/image.rs +++ b/src/image.rs @@ -18,6 +18,8 @@ use crate::datetime::datetime_from_unix_timestamp; use chrono::{DateTime, Utc}; /// Interface for accessing and manipulating a named docker image +/// +/// Api Reference: <https://docs.docker.com/engine/api/v1.41/#tag/Image> pub struct Image<'docker> { docker: &'docker Docker, name: String, @@ -39,6 +41,8 @@ impl<'docker> Image<'docker> { } /// Inspects a named image's details + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageInspect> pub async fn inspect(&self) -> Result<ImageDetails> { self.docker .get_json(&format!("/images/{}/json", self.name)[..]) @@ -46,6 +50,8 @@ impl<'docker> Image<'docker> { } /// Lists the history of the images set of changes + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageHistory> pub async fn history(&self) -> Result<Vec<History>> { self.docker .get_json(&format!("/images/{}/history", self.name)[..]) @@ -53,6 +59,8 @@ impl<'docker> Image<'docker> { } /// Deletes an image + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImagePrune> pub async fn delete(&self) -> Result<Vec<Status>> { self.docker .delete_json::<Vec<Status>>(&format!("/images/{}", self.name)[..]) @@ -60,6 +68,8 @@ impl<'docker> Image<'docker> { } /// Export this image to a tarball + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageGet> pub fn export(&self) -> impl Stream<Item = Result<Vec<u8>>> + Unpin + 'docker { Box::pin( self.docker @@ -69,6 +79,8 @@ impl<'docker> Image<'docker> { } /// Adds a tag to an image + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageTag> pub async fn tag( &self, opts: &TagOptions, @@ -94,6 +106,8 @@ impl<'docker> Images<'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 fn build( &self, opts: &BuildOptions, @@ -130,6 +144,8 @@ impl<'docker> Images<'docker> { } /// Lists the docker images on the current docker host + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageList> pub async fn list( &self, opts: &ImageListOptions, @@ -155,6 +171,8 @@ impl<'docker> Images<'docker> { } /// Search for docker images by term + /// + /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageSearch> pub async fn search( &self, term: &str, @@ -168,6 +186,8 @@ impl<'docker> Images<'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 pull( &self, opts: &PullOptions, @@ -188,6 +208,8 @@ impl<'docker> Images<'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 export( &self, names: Vec<&str>, @@ -203,6 +225,8 @@ impl<'docker> Images<'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> pub fn import<R>( self, mut tarball: R, |