Skip to main content

OutputStream

Struct OutputStream 

Source
pub struct OutputStream { /* private fields */ }
Expand description

Stream of output chunks from a process

Implementations§

Source§

impl OutputStream

Source

pub async fn next(&mut self) -> Option<OutputChunk>

Receive the next chunk

Source

pub fn kill(&mut self)

Stop the process using the configured kill signal (default SIGTERM).

This can be called from inside the consumption loop to stop a long-running or endless process; a terminating OutputChunk::Exit is still delivered afterwards.

Source

pub fn kill_with(&mut self, signal: &str)

Stop the process using an explicit signal, overriding the configured kill signal for this call.

Source

pub async fn collect(self) -> (Vec<u8>, Vec<u8>, i32)

Collect all remaining output into vectors

Source

pub async fn collect_stdout(self) -> Vec<u8>

Collect stdout only, discarding stderr

Trait Implementations§

Source§

impl AsyncIterator for OutputStream

Source§

type Item = OutputChunk

Source§

fn next<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<Self::Item>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get the next item from the iterator
Source§

impl Drop for OutputStream

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.