Struct SnapshotThenStream 

pub struct SnapshotThenStream<TSnapshot, TPublication> { /* private fields */ }

Coordinates REST snapshot hydration with a live protobuf channel.

Implementations

impl<TSnapshot, TPublication> SnapshotThenStream<TSnapshot, TPublication>

where TSnapshot: Send + 'static, TPublication: Send + 'static,

pub fn new(cfg: SnapshotThenStreamConfig<TSnapshot, TPublication>) -> Self

pub async fn start(&self) -> Result<()>

Begin websocket streaming and perform the initial snapshot refresh.

pub async fn refresh_snapshot(&self) -> Result<()>

Fetch a REST snapshot and merge buffered publications.

On failure, readiness stays false, Self::err is set, and the pending buffer is retained so a successful retry merges each buffered publication exactly once. Success clears err.

pub fn request_refresh(&self)

Request a snapshot refresh from a sync context (e.g. sequence gap handler).

Requests are coalesced behind one worker. A request arriving during a fetch schedules a follow-up, while repeated failures or persistent gaps fail closed after a bounded number of attempts.

pub fn is_ready(&self) -> bool

pub fn is_disposed(&self) -> bool

pub fn err(&self) -> Option<Error>

Terminal stream error, if recovery failed closed.

pub fn set_on_error<F>(&self, callback: F)

where F: Fn(Error) + Send + Sync + 'static,

Register a callback for transport, decode, snapshot, and terminal buffering errors.

If an error was already recorded, the callback is invoked immediately. Callback panics are isolated from the stream worker.

pub fn close(&self)

Stop the stream.

Trait Implementations

impl<TSnapshot, TPublication> Clone for SnapshotThenStream<TSnapshot, TPublication>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TSnapshot, TPublication> Drop for SnapshotThenStream<TSnapshot, TPublication>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.