Struct docker_api::api::exec::Exec

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

Api Reference

Interface for docker exec instance

Implementations

impl<'docker> Exec<'docker>

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

Api Reference

Inspect this Exec.

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

Api Reference

Creates a new exec instance that will be executed in a container with id == container_id.

pub 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

Api Reference

Starts this exec instance returning a multiplexed tty stream.

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

Api Reference

Resize the TTY session used by an exec instance. This only works if the exec was created with tty enabled.