Struct TypedSubscription 

pub struct TypedSubscription<T> { /* private fields */ }

Handle for a typed protobuf realtime subscription.

After a transport reconnect the subscription is re-established without a server-side resume cursor. Self::resubscribes / Self::take_resubscribed signal that gap: publications may have been lost.

Implementations

impl<T> TypedSubscription<T>

pub async fn recv(&mut self) -> Option<T>

pub async fn recv_result(&mut self) -> Result<Option<T>>

Receive one publication while preserving terminal delivery failures.

Unlike Self::recv, a closed feed with a recorded error returns that error instead of being indistinguishable from a clean shutdown.

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

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

Register a callback for background transport/protocol errors.

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

pub fn is_alive(&self) -> bool

True while the background websocket task is still running.

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

Most recent connection or terminal delivery error.

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

Take and clear the most recent background error.

pub fn resubscribes(&self) -> u64

How many times this subscription successfully reconnected after the initial connect. Non-zero means the stream may have gaps.

pub fn take_resubscribed(&self) -> bool

Reports whether a reconnect/resubscribe happened since the last call and clears the latch. The initial connect does not set the latch.

pub fn close(&self)

Trait Implementations

impl<T> Drop for TypedSubscription<T>

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.