Struct docker_api::exec::Exec

pub struct Exec<'docker> { /* fields omitted */ }

Interface for docker exec instance

Api Reference: https://docs.docker.com/engine/api/v1.41/#tag/Exec

Implementations

impl<'docker> Exec<'docker>

pub async fn create<C>(
    docker: &'docker Docker,
    container_id: C,
    opts: &ExecContainerOptions
) -> Result<Exec<'docker>> where
    C: AsRef<str>, 

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

pub async fn get<I>(docker: &'docker Docker, id: I) -> Exec<'docker> where
    I: Into<String>, 

Get a reference to a set of operations available to an already created exec instance.

It’s in callers responsibility to ensure that exec instance with specified id actually exists. Use Exec::create to ensure that the exec instance is created beforehand.

pub fn start(&self) -> impl Stream<Item = Result<TtyChunk>> + 'docker

Starts this exec instance returning a multiplexed tty stream

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ExecStart

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

Inspect this exec instance to aquire detailed information

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/ExecInpsect

pub async fn resize(&self, opts: &ExecResizeOptions) -> Result<()>

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