Struct OpenStreamSession 

pub struct OpenStreamSession { /* private fields */ }

Readable reader-side handle for a CEP-41 stream.

Cheaply clonable (Arc-backed): the registry holds one clone to feed frames while the consumer holds another to drain the Stream.

Implementations

impl OpenStreamSession

pub fn new(options: OpenStreamSessionOptions) -> Self

Create a new reader session from explicit options.

pub fn progress_token(&self) -> &str

The stream id (stringified progressToken).

pub fn is_active(&self) -> bool

Whether the stream is still live (not yet closed/aborted/failed).

pub fn has_started(&self) -> bool

Whether the start frame has been observed.

pub fn process_frame( &self, now: Instant, progress: i64, frame: OpenStreamFrame, ) -> Result<FrameOutcome, OpenStreamError>

Process one inbound frame, stamping last_activity = now.

Returns the FrameOutcome the async caller must act on (publish a pong, observe a terminal close/abort). On a sequencing/policy violation it returns Err without finalizing — the caller (registry) decides whether to fail the session.

pub fn tick(&self, now: Instant) -> KeepaliveAction

Pure keepalive transition (idle → ping, probe/grace → abort). Driven by the owning transport’s periodic sweep with Instant::now().

pub fn fail(&self, error: OpenStreamError)

Terminate the stream with an explicit error (no abort frame published). Mirrors the registry’s fail path; the error surfaces on the next poll.

pub fn dispose(&self)

Dispose the stream gracefully (ends the Stream with None). Used by the registry’s clear; runs no hooks.

pub async fn abort(&self, reason: Option<String>)

Consumer-initiated cancel: finalize locally (terminal abort error on the next poll) and, if a publisher was injected, emit an abort frame to the peer. Idempotent; the transport exposes this as the consumer’s stream cancel.

pub fn closed(&self) -> Closed

A future that resolves to () when the stream finalizes (graceful close, abort, fail, or dispose). It never carries the terminal error — that is delivered once on the Stream (intentional Rust divergence from TS).

Trait Implementations

impl Clone for OpenStreamSession

fn clone(&self) -> OpenStreamSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenStreamSession

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

Formats the value using the given formatter.

impl Stream for OpenStreamSession

type Item = Result<String, OpenStreamError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.