Enum StreamChunk 

#[non_exhaustive]
pub enum StreamChunk<O> {
    Value(O),
    Update {
        node: String,
        value: O,
    },
    Message(StreamDelta),
    Debug(DebugEvent),
    Event(RunnableEvent),
}

One chunk of a streaming Runnable invocation.

Generic over the runnable’s output type O. Chunks not relevant to a chosen mode are simply not emitted; the variant the caller observes is determined by the requested StreamMode.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Value(O)

Full snapshot — emitted in StreamMode::Values.

Update

Per-node update — emitted in StreamMode::Updates.

Fields

node: String

Identifier of the node (or runnable) that produced value.

value: O

State (or output) the node produced this step.

Message(StreamDelta)

Token-level delta — emitted in StreamMode::Messages.

Debug(DebugEvent)

Lifecycle marker — emitted in StreamMode::Debug.

Event(RunnableEvent)

Runtime event — emitted in StreamMode::Events.

Implementations

impl<O> StreamChunk<O>

pub const fn output(&self) -> Option<&O>

Borrow the inner O if this chunk carries one (Value or Update); otherwise None.

pub fn into_output(self) -> Option<O>

Consume the chunk, returning the inner O for the carrier variants.

Trait Implementations

impl<O: Clone> Clone for StreamChunk<O>

fn clone(&self) -> StreamChunk<O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for StreamChunk<O>

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

Formats the value using the given formatter.