Struct StreamReader 

pub struct StreamReader { /* private fields */ }

A reader of a run’s stream (crate::RunHandle::stream): yields each chunk once it is durable, in order, and ends once the stream is complete. Self::offset is where a reader that reconnects continues.

Implementations

impl StreamReader

pub fn from(self, offset: u64) -> Self

Starts at chunk offset instead of the first.

pub fn of_run(self, run: RunId) -> Self

Reads the stream of run (an earlier reader’s Self::run), not the workflow ID’s newest run.

pub fn wait(self, wait: Duration) -> Self

How long one read waits for a new chunk before it asks again (default 30 s); it only bounds a request, not the reader.

pub fn offset(&self) -> u64

The offset of the chunk Self::next returns next.

pub fn run(&self) -> Option<RunId>

The run being read, once the first read found it.

pub fn end(&self) -> Option<&StreamEnd>

How the stream ended, once Self::next returned None.

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

The next chunk, waiting until one is durable; None once the stream is complete.

Trait Implementations

impl Debug for StreamReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.