Struct OutputStream 

pub struct OutputStream { /* private fields */ }

Stream of output chunks from a process

Implementations

impl OutputStream

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

Receive the next chunk

pub fn exit_signal(&self) -> Option<String>

Signal reported by the native child, available once it exits. Ordinary exit codes above 128 are not mistaken for signals.

pub fn pid(&self) -> Option<u32>

Process id of the streamed command, as currently known.

The child is spawned by a background task, so this is None for the short window between StreamingRunner::stream returning and the spawn completing, and stays None if the spawn failed. From the first delivered chunk onwards it is set, and it remains readable after the process has exited. Use wait_for_pid to avoid the startup window.

pub async fn wait_for_pid(&mut self) -> Option<u32>

Process id of the streamed command, waiting for the spawn to complete.

Resolves as soon as the child exists, and returns None if the process could never be spawned. This is the streaming counterpart of awaiting a stream before reading runner.pid in JavaScript.

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.

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

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

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

Collect all remaining output into vectors

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

Collect stdout only, discarding stderr

Trait Implementations

impl AsyncIterator for OutputStream

type Item = OutputChunk

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

impl Drop for OutputStream

fn drop(&mut self)

Executes the destructor for this type.

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.