Skip to main content

StreamingRunner

Struct StreamingRunner 

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

A streaming process runner that allows async iteration over output

Implementations§

Source§

impl StreamingRunner

Source

pub fn new(command: impl Into<String>) -> Self

Create a new streaming runner

Source

pub fn cwd(self, path: impl Into<PathBuf>) -> Self

Set the working directory

Source

pub fn env(self, env: HashMap<String, String>) -> Self

Set environment variables

Source

pub fn stdin(self, content: impl Into<String>) -> Self

Set stdin content

Source

pub fn kill_signal(self, signal: impl Into<String>) -> Self

Configure the signal used to stop the process when it is killed without an explicit signal — i.e. OutputStream::kill or abandoning the stream. Mirrors the JavaScript killSignal option (default SIGTERM).

The reported exit code follows the conventional 128 + signal mapping (e.g. SIGTERM => 143, SIGINT => 130, SIGKILL => 137).

Source

pub fn exit_pump_grace_ms(self, ms: u64) -> Self

Configure the grace period (in milliseconds) to keep draining the stdio pipes after the process exits before aborting lingering readers. Mirrors the JavaScript exitPumpGrace option (default 100ms).

Source

pub fn stream(self) -> OutputStream

Start the process and return a stream of output chunks

Source

pub async fn collect(self) -> Result<CommandResult>

Run to completion and collect all output

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.