Struct dittolive_ditto::sync::Sync

pub struct Sync { /* private fields */ }

Ditto’s Sync API, obtained via ditto.sync().

See the sync module documentation for more details.

Implementations

impl Sync

pub fn subscriptions( &self, ) -> impl '_ + Deref<Target = SetArc<SyncSubscription>>

Gets temporary access to the set of currently registered subscriptions.

A (read) lock is held until the return value is dropped: this means that neither Self::register_subscription() nor SyncSubscription::cancel() can make progress until this read lock is released.

pub fn register_subscription<Q>( &self, query: Q, query_args: Option<QueryArguments>, ) -> Result<Arc<SyncSubscription>, DittoError>

where Q: TryInto<Query, Error = DittoError>,

Use a DQL query to subscribe to data on other Ditto peers.

While the subscription is active, data matching this query on other peers will be synced to the local peer’s data store.

Note that dropping the SyncSubscription won’t cancel it, to do that be sure to use sync_subscription.cancel().

Example

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

// Cancel the subscription with `.cancel()`
sync_subscription.cancel();