Struct kube_client::api::AttachedProcess

source ·
pub struct AttachedProcess { /* private fields */ }
Expand description

Represents an attached process in a container for attach and exec.

Provides access to stdin, stdout, and stderr if attached.

Use AttachedProcess::join to wait for the process to terminate.

Implementations§

source§

impl AttachedProcess

source

pub fn stdin(&mut self) -> Option<impl AsyncWrite + Unpin>

Async writer to stdin.

let mut stdin_writer = attached.stdin().unwrap();
stdin_writer.write(b"foo\n").await?;

Only available if AttachParams had stdin.

source

pub fn stdout(&mut self) -> Option<impl AsyncRead + Unpin>

Async reader for stdout outputs.

let mut stdout_reader = attached.stdout().unwrap();
let mut buf = [0u8; 4];
stdout_reader.read_exact(&mut buf).await?;

Only available if AttachParams had stdout.

source

pub fn stderr(&mut self) -> Option<impl AsyncRead + Unpin>

Async reader for stderr outputs.

let mut stderr_reader = attached.stderr().unwrap();
let mut buf = [0u8; 4];
stderr_reader.read_exact(&mut buf).await?;

Only available if AttachParams had stderr.

source

pub fn abort(&self)

Abort the background task, causing remote command to fail.

source

pub async fn join(self) -> Result<(), Error>

Waits for the remote command task to complete.

source

pub fn take_status(&mut self) -> Option<impl Future<Output = Option<Status>>>

Take a future that resolves with any status object or when the sender is dropped.

Returns None if called more than once.

source

pub fn terminal_size(&mut self) -> Option<Sender<TerminalSize>>

Async writer to change the terminal size

let mut terminal_size_writer = attached.terminal_size().unwrap();
terminal_size_writer.send(TerminalSize{
    height: 100,
    width: 200,
}).await?;

Only available if AttachParams had tty.

Auto Trait Implementations§

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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