Struct dittolive_ditto::sync::SyncSubscription

pub struct SyncSubscription { /* private fields */ }

Use ditto.sync().register_subscription(...) to create a SyncSubscription

The subscription will remain active until either:

• the SyncSubscription is explicitly canceled via .cancel(), or
• the owning Ditto object goes out of scope

See the sync module documentation for more details.

Implementations

impl SyncSubscription

pub fn cancel(&self)

Cancels the SyncSubscription so that new changes matching the query are no longer received from other peers. No-op if it’s already cancelled or the owning Ditto object goes out of scope.

pub fn is_cancelled(&self) -> bool

Returns true if this SyncSubscription has been cancelled, false otherwise

Trait Implementations

impl Display for SyncSubscription

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

Formats the value using the given formatter.

impl Hash for SyncSubscription

fn hash<H: Hasher>(&self, h: &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 SyncSubscription

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SyncSubscription

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SyncSubscription

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for SyncSubscription