diff options
| author | Matthias Beyer <mail@beyermatthias.de> | 2021-04-09 09:01:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-09 09:01:46 +0200 |
| commit | c9156ea3b157a7d3f1407eb9819c93888bdb2382 (patch) | |
| tree | d1c99551e4b7627e46c3e2baa80d26f963be34fc /src/network.rs | |
| parent | 2cba96a44c6e9150c38a12b60b55c32c1c345488 (diff) | |
| parent | d9848a08b24b36487b1c63264a8eeb10730568d0 (diff) | |
Merge pull request #279 from wojciechkepka/docs
Add Docker API reference hyperlinks to doc comments
Diffstat (limited to 'src/network.rs')
| -rw-r--r-- | src/network.rs | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/network.rs b/src/network.rs index c12cba9..62d8bbe 100644 --- a/src/network.rs +++ b/src/network.rs @@ -18,6 +18,8 @@ use crate::{ }; /// Interface for docker network +/// +/// API Reference: <https://docs.docker.com/engine/api/v1.41/#tag/Network> pub struct Networks<'docker> { docker: &'docker Docker, } @@ -29,6 +31,8 @@ impl<'docker> Networks<'docker> { } /// List the docker networks on the current docker host + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkList> pub async fn list( &self, opts: &NetworkListOptions, @@ -52,6 +56,8 @@ impl<'docker> Networks<'docker> { } /// Create a new Network instance + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkCreate> pub async fn create( &self, opts: &NetworkCreateOptions, @@ -92,6 +98,8 @@ impl<'docker> Network<'docker> { } /// Inspects the current docker network instance's details + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkInspect> pub async fn inspect(&self) -> Result<NetworkInfo> { self.docker .get_json(&format!("/networks/{}", self.id)[..]) @@ -99,6 +107,8 @@ impl<'docker> Network<'docker> { } /// Delete the network instance + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkDelete> pub async fn delete(&self) -> Result<()> { self.docker .delete(&format!("/networks/{}", self.id)[..]) @@ -107,6 +117,8 @@ impl<'docker> Network<'docker> { } /// Connect container to network + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkConnect> pub async fn connect( &self, opts: &ContainerConnectionOptions, @@ -115,6 +127,8 @@ impl<'docker> Network<'docker> { } /// Disconnect container to network + /// + /// API Reference: <https://docs.docker.com/engine/api/v1.41/#operation/NetworkDisconnect> pub async fn disconnect( &self, opts: &ContainerConnectionOptions, |