diff options
Diffstat (limited to 'src/exec.rs')
| -rw-r--r-- | src/exec.rs | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/exec.rs b/src/exec.rs index 2f512a9..2eedb7b 100644 --- a/src/exec.rs +++ b/src/exec.rs @@ -20,7 +20,7 @@ use crate::{ /// Interface for docker exec instance /// -/// Api Reference: <https://docs.docker.com/engine/api/v1.41/#tag/Exec> +/// [Api Reference](https://docs.docker.com/engine/api/v1.41/#tag/Exec) pub struct Exec<'docker> { docker: &'docker Docker, id: String, @@ -42,7 +42,7 @@ impl<'docker> Exec<'docker> { /// Creates a new exec instance that will be executed in a container with id == container_id /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ContainerExec> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ContainerExec) pub async fn create( docker: &'docker Docker, container_id: &str, @@ -137,7 +137,7 @@ impl<'docker> Exec<'docker> { /// Starts this exec instance returning a multiplexed tty stream /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ExecStart> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ExecStart) pub fn start(&self) -> impl Stream<Item = Result<tty::TtyChunk>> + 'docker { // We must take ownership of the docker reference to not needlessly tie the stream to the // lifetime of `self`. @@ -161,7 +161,7 @@ impl<'docker> Exec<'docker> { /// Inspect this exec instance to aquire detailed information /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ExecInpsect> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ExecInpsect) pub async fn inspect(&self) -> Result<ExecDetails> { self.docker .get_json(&format!("/exec/{}/json", &self.id)[..]) @@ -171,7 +171,7 @@ impl<'docker> Exec<'docker> { /// Resize the TTY session used by an exec instance. This only works if the exec was created /// with `tty` enabled. /// - /// Api Reference: <https://docs.docker.com/engine/api/v1.41/#operation/ExecResize> + /// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ExecResize) pub async fn resize( &self, opts: &ExecResizeOptions, |