Struct StreamSegment 

pub struct StreamSegment {
    pub stream_id: String,
    pub seq: u64,
    pub final_segment: bool,
    pub schema: String,
    pub payload: Value,
}

A segment within a continuously ordered data stream.

Typical use cases include AI token streams, file transfers, audio/video frames, etc. All messages belonging to the same stream share a stream_id and are ordered by seq.

Fields

stream_id: String

Stream identifier — all segments of the same stream share this value.

Generated by the sender when the stream starts (typically a ULID).

seq: u64

Monotonically increasing sequence number within the stream (starting from 0).

The receiver uses this to order segments and detect any missing ones.

final_segment: bool

Whether this is the final segment.

true indicates the stream has ended; the receiver should complete stream processing and clean up associated state.

schema: String

Schema identifier, formatted as {domain}.{name}@{major}.{minor}.

Defines the structure of payload, e.g. "ai.token@1.0", "file.chunk@1.0".

payload: Value

Segment payload in JSON format.

For AI token streams, this is typically {"text": "..."}. For file transfers, this is typically a Base64-encoded data chunk.

Trait Implementations

impl Clone for StreamSegment

fn clone(&self) -> StreamSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSegment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamSegment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamSegment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.