Struct SubscriptionId 

pub struct SubscriptionId { /* private fields */ }

An opaque handle identifying one subscription for as long as you hold it.

It survives everything the session does — a rebind, a recovery, and even a replacement of the session by a new one. That is deliberate: the protocol’s own subscription numbers are only unique within a session and restart at one when a session is replaced [docs/spec/02-session-lifecycle.md §4.4], so a caller given those numbers would see its subscriptions change identity for reasons that have nothing to do with them.

It names its client too

Every client numbers its own subscriptions from one, so the bare number is only unique within one client. The handle therefore carries the identity of the client that created it, and Client::unsubscribe refuses one that came from a different client with Error::ForeignSubscription. Two clients in one process inevitably hand out the same numbers; without this they would hand out interchangeable handles, and cancelling the wrong data would be a plain type-checked call away.

Get one from Updates::id.

Implementations

impl SubscriptionId

pub const fn get(self) -> u64

An opaque number, for logging and for use as a map key.

Unique within one client: two clients each number their subscriptions from one, so this alone does not identify a subscription in a process that has more than one client. It is not the protocol’s LS_subId and must not be sent anywhere.

Trait Implementations

impl Clone for SubscriptionId

fn clone(&self) -> SubscriptionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubscriptionId

impl Debug for SubscriptionId

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

Formats the value using the given formatter.

impl Display for SubscriptionId

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

Formats the value using the given formatter.

impl Eq for SubscriptionId

impl Hash for SubscriptionId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SubscriptionId

fn cmp(&self, other: &SubscriptionId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SubscriptionId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SubscriptionId

fn partial_cmp(&self, other: &SubscriptionId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SubscriptionId