Enum StreamMessage 

#[non_exhaustive]
pub enum StreamMessage {
    StreamBegin {
        stream_id: String,
        plan_id: PlanId,
        total_chunks: Option<usize>,
        plan: Box<SerializedPlan>,
    },
    ChunkData {
        stream_id: String,
        chunk_index: usize,
        value: Value,
    },
    StreamEnd {
        stream_id: String,
    },
    ChunkResult {
        stream_id: String,
        chunk_index: usize,
        value: Value,
    },
    StreamComplete {
        stream_id: String,
        result: PlanResult,
    },
}

Streaming protocol: chunked data transfer over WebSocket Binary frames.

Wire format: msgpack-encoded StreamMessage (efficient binary, no JSON overhead). Client sends StreamBegin + N × ChunkData + StreamEnd. Worker responds with ChunkResult per chunk — except while a Barrier-mode node is accumulating, which yields nothing until the flush — and StreamComplete at the end.

The worker drives each session with the runtime’s StreamRun, the same stream executor a local Graph.stream() uses, so chunk caching and StreamMode semantics do not fork between local and remote.

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.

StreamBegin

Begin a streaming session.

Fields

stream_id: String

Names the session; every later frame quotes it.

plan_id: PlanId

The execution id the session runs under.

total_chunks: Option<usize>

Number of chunks (None if unknown ahead of time).

plan: Box<SerializedPlan>

The plan to execute — input comes via chunks, not inline.

ChunkData

A single chunk of input data.

Fields

stream_id: String

Which session the chunk belongs to.

chunk_index: usize

Position in the stream, echoed back in the matching StreamMessage::ChunkResult.

value: Value

The chunk itself.

StreamEnd

All chunks have been sent.

Fields

stream_id: String

Which session the sender has finished feeding.

ChunkResult

Result for a processed chunk (streamed back to client).

Fields

stream_id: String

Which session produced the result.

chunk_index: usize

Index of the input chunk this result answers.

value: Value

The processed chunk.

StreamComplete

Final result after all chunks processed.

Fields

stream_id: String

Which session finished.

result: PlanResult

The flush output on success — where Barrier-mode results arrive — or the failure that ended the run.

Trait Implementations

impl Clone for StreamMessage

fn clone(&self) -> StreamMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.