Struct 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 query_string(&self) -> String

Returns the DQL query string that this SyncSubscription is subscribed to.

Example

use dittolive_ditto::prelude::*;

let sync_subscription = ditto
    .sync()
    .register_subscription("SELECT * FROM cars", None)?;

assert_eq!(sync_subscription.query_string(), "SELECT * FROM cars");

pub fn query_arguments(&self) -> Option<Value>

Returns the DQL query arguments that this SyncSubscription is subscribed to.

Example

use dittolive_ditto::prelude::*;

let sync_subscription = ditto
    .sync()
    .register_subscription("SELECT * FROM cars", Some(serde_json::json!({
        "color": "red",
    }).into()))?;

let maybe_args = sync_subscription.query_arguments();
let args = maybe_args.expect("expected query arguments");
let args_json = serde_json::to_value(&args)?;

assert_eq!(args_json, serde_json::json!({
   "color": "red",
}));

pub fn cancel(&self)

Cancels this SyncSubscription, so that changes matching the query are no longer synced from other peers to this one.

Example

use dittolive_ditto::Ditto;

let subscription = ditto
    .sync()
    .register_subscription("SELECT * FROM cars", None)?;
assert!(!subscription.is_cancelled());

subscription.cancel();
assert!(subscription.is_cancelled());

pub fn is_cancelled(&self) -> bool

Returns true if this SyncSubscription has been cancelled, false otherwise.

Example

use dittolive_ditto::Ditto;

let subscription = ditto
    .sync()
    .register_subscription("SELECT * FROM cars", None)?;
assert!(!subscription.is_cancelled());

subscription.cancel();
assert!(subscription.is_cancelled());

Trait Implementations

impl Debug for SyncSubscription

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

Formats the value using the given formatter.

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,

Restrict a value to a certain interval.

impl PartialEq for SyncSubscription

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

Tests for self and other values to be equal, and is used by ==.

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

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

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 Eq for SyncSubscription