Struct StreamSegment 

pub struct StreamSegment { /* private fields */ }

Builder for streaming segment metadata.

Manages session/segment IDs and auto-incrementing sequence numbers for real-time streaming patterns (voice, video, sensor streams).

Implementations

impl StreamSegment

pub fn new() -> Self

Start a new session with a generated session ID and segment 0.

pub fn with_session_id(session_id: String) -> Self

Start a new session with an explicit session ID.

pub fn next_segment(&mut self) -> i64

Advance to a new segment (resets seq to 0). Returns the new segment_id.

pub fn chunk(&mut self, fin: bool) -> MetadataParameters

Build metadata parameters for a chunk. Auto-increments seq.

pub fn flush(&mut self) -> MetadataParameters

Build metadata for a flush message (new segment, discards older queued data).

Advances to a new segment, then emits a chunk with flush=true and fin=false. The prior segment ends without a fin=true signal – this is intentional for interruption semantics (the old data is being discarded, not completed).

Note: flush discards all queued messages on the receiver’s input regardless of session_id. Do not multiplex independent sessions on a single DataId when using flush.

pub fn session_id(&self) -> &str

Returns the session ID.

pub fn segment_id(&self) -> i64

Returns the current segment ID.

pub fn seq(&self) -> i64

Returns the sequence number that will be used by the next chunk() call.

Trait Implementations

impl Default for StreamSegment

fn default() -> Self

Returns the “default value” for a type.