Struct StreamReader 

pub struct StreamReader { /* private fields */ }

A cursor over one live output stream. StreamReader::next blocks up to a timeout for the next chunk.

Implementations

impl StreamReader

pub fn next(&mut self, timeout: Duration) -> ReadStep

Block up to timeout for the next step: the next retained chunk, Eof once the stream is closed and fully drained, or Pending if nothing new arrived in time.

pub fn try_next(&mut self) -> Option<Vec<u8>>

The next retained chunk if one is already buffered, without blocking. None means the ring is momentarily drained (not that the stream ended); callers batch-draining an interactive stream use it to flush several chunks in one write.

pub fn took_drop(&mut self) -> bool

Whether the ring evicted output this reader had not yet consumed since the last call, clearing the flag. An interactive consumer uses it to trigger a screen repaint (ExecProcess::resync) after falling behind.

pub fn took_reset(&mut self) -> bool

Whether the ring was reset to a repaint (a Snapshot superseded the stream) since the last call, clearing the flag. An interactive consumer drops any stale terminal-local backlog on this so the repaint it is about to read renders at once instead of stuck behind bytes the terminal will never finish draining.