Struct OutputCapture 

pub struct OutputCapture { /* private fields */ }

A background drain of one output stream into a bounded byte buffer. See the module documentation.

Implementations

impl OutputCapture

pub fn capture<R: Read + Send + 'static>(reader: R, max_bytes: usize) -> Self

Drains reader on a thread, keeping the first max_bytes bytes. Best effort: if the thread cannot be spawned the capture holds nothing (use try_capture to learn that).

pub fn try_capture<R: Read + Send + 'static>( reader: R, max_bytes: usize, ) -> Result<Self>

Like capture, but returns the operating-system error when the drain thread cannot be spawned.

pub fn snapshot(&self) -> CapturedOutput

What has been captured so far.

pub fn take_error(&self) -> Option<Error>

The error that stopped the drain before the end of the stream, taken once. None when the stream ended cleanly or is still open.

pub fn finish(&mut self) -> CapturedOutput

Waits for the stream to end (the child exited and no grandchild holds the pipe), then returns the complete capture.

pub fn finish_within(&mut self, timeout: Duration) -> CapturedOutput

Like finish but gives up after timeout (a grandchild that inherited the pipe keeps it open after the child is gone) and returns what was captured so far. Never joins the thread; finish can still do that later.

pub fn is_finished(&self) -> bool

True once the stream has ended (or failed).