Struct shiplift::exec::Exec[][src]

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

Interface for docker exec instance

Api Reference


impl<'docker> Exec<'docker>[src]

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

Api Reference

pub async fn get<S>(docker: &'docker Docker, id: S) -> Exec<'docker> where
    S: 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[src]

Starts this exec instance returning a multiplexed tty stream

Api Reference

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

Inspect this exec instance to aquire detailed information

Api Reference

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

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

Api Reference

Auto Trait Implementations

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

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.