pub struct Exec<'docker> { /* private fields */ }
Expand description
Interface for docker exec instance
Implementations§
Source§impl<'docker> Exec<'docker>
impl<'docker> Exec<'docker>
Sourcepub async fn create(
docker: &'docker Docker,
container_id: &str,
opts: &ExecContainerOptions,
) -> Result<Exec<'docker>>
pub async fn create( docker: &'docker Docker, container_id: &str, opts: &ExecContainerOptions, ) -> Result<Exec<'docker>>
Creates a new exec instance that will be executed in a container with id == container_id
Sourcepub async fn get<S>(docker: &'docker Docker, id: S) -> Exec<'docker>
pub async fn get<S>(docker: &'docker Docker, id: S) -> Exec<'docker>
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.
Sourcepub fn start(&self) -> impl Stream<Item = Result<TtyChunk>> + 'docker
pub fn start(&self) -> impl Stream<Item = Result<TtyChunk>> + 'docker
Starts this exec instance returning a multiplexed tty stream
Sourcepub async fn inspect(&self) -> Result<ExecDetails>
pub async fn inspect(&self) -> Result<ExecDetails>
Inspect this exec instance to aquire detailed information
Sourcepub async fn resize(&self, opts: &ExecResizeOptions) -> Result<()>
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.
Auto Trait Implementations§
impl<'docker> Freeze for Exec<'docker>
impl<'docker> !RefUnwindSafe for Exec<'docker>
impl<'docker> Send for Exec<'docker>
impl<'docker> Sync for Exec<'docker>
impl<'docker> Unpin for Exec<'docker>
impl<'docker> !UnwindSafe for Exec<'docker>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more