Struct StreamFrames 

pub struct StreamFrames {
    pub frames: Vec<StreamFrame>,
    pub closed_at: Option<TimestampMs>,
    pub closed_reason: Option<String>,
}

Result of read_stream / tail_stream — frames plus the terminal signal so polling consumers can exit cleanly.

Re-export of ff_core::contracts::StreamFrames for SDK ergonomics. Result of reading frames from an attempt stream — frames plus terminal signal so consumers can stop polling without a timeout fallback.

Fields

frames: Vec<StreamFrame>

Entries in the requested range (possibly empty).

closed_at: Option<TimestampMs>

Timestamp when the upstream writer closed the stream. None if the stream is still open (or has never been written).

closed_reason: Option<String>

Reason from the closing writer. Current values: attempt_success, attempt_failure, attempt_cancelled, attempt_interrupted. None iff the stream is still open.

Implementations

impl StreamFrames

pub fn empty_open() -> StreamFrames

Construct an empty open-stream result (no frames, no terminal markers). Useful for fast-path peek helpers.

pub fn is_closed(&self) -> bool

True iff the producer has closed this stream. Consumers should stop polling and drain once this returns true.

Trait Implementations

impl Clone for StreamFrames

fn clone(&self) -> StreamFrames

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamFrames

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamFrames

fn deserialize<__D>( __deserializer: __D, ) -> Result<StreamFrames, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StreamFrames

fn eq(&self, other: &StreamFrames) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamFrames

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StreamFrames

impl StructuralPartialEq for StreamFrames