Struct Subscription 

pub struct Subscription { /* private fields */ }

Managed orderbook stream with snapshot prefetch and sequence-checked deltas.

Delivery contract: a full consumer queue fails the subscription with Error::QueueOverflow instead of silently dropping books.

Implementations

impl Subscription

pub fn updates(&mut self) -> &mut Receiver<OrderbookData>

Receiver for merged orderbook snapshots.

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

Terminal subscription error, if the stream failed (e.g. queue overflow).

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

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

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

pub fn set_bucket(&self, bucket: &str) -> Result<()>

Change the active price bucket and re-emit the current book.

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

Refetch the REST snapshot.

pub fn close(&self)

Stop the subscription.

Trait Implementations

impl Drop for Subscription

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.