diff options
Diffstat (limited to 'src/image.rs')
| -rw-r--r-- | src/image.rs | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/image.rs b/src/image.rs index e69f85a..addf4ee 100644 --- a/src/image.rs +++ b/src/image.rs @@ -19,7 +19,7 @@ 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> +/// [Api Reference](https://docs.docker.com/engine/api/v1.41/#tag/Image) pub struct Image<'docker> { docker: &'docker Docker, name: String, @@ -42,7 +42,7 @@ impl<'docker> Image<'docker> { /// Inspects a named image's details /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageInspect> + /// [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)[..]) @@ -51,7 +51,7 @@ 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> + /// [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)[..]) @@ -60,7 +60,7 @@ impl<'docker> Image<'docker> { /// Deletes an image /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImagePrune> + /// [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)[..]) @@ -69,7 +69,7 @@ impl<'docker> Image<'docker> { /// Export this image to a tarball /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageGet> + /// [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 @@ -80,7 +80,7 @@ impl<'docker> Image<'docker> { /// Adds a tag to an image /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageTag> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageTag) pub async fn tag( &self, opts: &TagOptions, @@ -107,7 +107,7 @@ 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> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageBuild) pub fn build( &self, opts: &BuildOptions, @@ -145,7 +145,7 @@ 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> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageList) pub async fn list( &self, opts: &ImageListOptions, @@ -172,7 +172,7 @@ impl<'docker> Images<'docker> { /// Search for docker images by term /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ImageSearch> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageSearch) pub async fn search( &self, term: &str, @@ -187,7 +187,7 @@ 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> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImagePull) pub fn pull( &self, opts: &PullOptions, @@ -209,7 +209,7 @@ 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> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageGetAll) pub fn export( &self, names: Vec<&str>, @@ -226,7 +226,7 @@ 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> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ImageLoad) pub fn import<R>( self, mut tarball: R, |