Struct Stream 

pub struct Stream<T> { /* private fields */ }

Defines a typed best-effort resumable message Stream owned by one Flow type.

Register the same definition in exactly one crate::PersistenceSchema. Clones share identity and may be used at Client and Step call sites.

Implementations

impl<T> Stream<T>

pub fn new(name: impl Into<String>, stream_capacity_bytes: i64) -> Self

Creates a Stream with a positive approximate budget shared by all instances of its Flow.

Panics

Panics when name is empty or stream_capacity_bytes is not positive.

pub fn name(&self) -> &str

Returns the stable logical Stream name.

pub fn stream_capacity_bytes(&self) -> i64

Returns the approximate shared byte budget.

pub fn write(&self, context: &mut Context, value: T) -> HandlerResult<()>

where T: Value,

Appends one message immediately from the current Step execution.

Errors

Returns crate::HandlerError for RPC or Flow timeout Contexts, unregistered Streams, encoding failures, cancellation, or a closed Worker output stream. Dex storage failures are not acknowledged.

impl Stream<String>

pub fn buffered_text( &self, context: &mut Context, ) -> HandlerResult<BufferedTextStream>

Creates an invocation-managed writer with a one-second interval and 16 KiB threshold.

The Worker flushes remaining text before the handler result or error. The writer preserves chunks exactly, ignores empty chunks, and never splits a chunk.

Errors

Returns HandlerError unless this registered String Stream is used by an active Step.

pub fn buffered_text_with_options( &self, context: &mut Context, options: BufferedTextStreamOptions, ) -> HandlerResult<BufferedTextStream>

Creates an invocation-managed writer with explicit buffering settings.

Errors

Returns HandlerError for invalid settings, an unregistered Stream, cancellation, or a Context that does not belong to a Step.

Trait Implementations

impl<T: Clone> Clone for Stream<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Stream<T>

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

Formats the value using the given formatter.