Struct Exec

Source
pub struct Exec<'docker> { /* private fields */ }
Expand description

Interface for docker exec instance

Api Reference

Implementations§

Source§

impl<'docker> Exec<'docker>

Source

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

Source

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.

Source

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

Starts this exec instance returning a multiplexed tty stream

Api Reference

Source

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

Inspect this exec instance to aquire detailed information

Api Reference

Source

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

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T