Struct Subscription 

pub struct Subscription {
    pub collection: String,
    pub query: Query,
    pub qos: SubscriptionQoS,
}

Subscription configuration with QoS policy

Combines a collection, query filter, and QoS settings for fine-grained control over what data syncs and how it syncs.

Example

use peat_mesh::sync::types::{Subscription, Query, GeoPoint, SubscriptionQoS};
use peat_mesh::qos::SyncMode;

// Subscribe to nearby beacons with LatestOnly sync
let subscription = Subscription {
    collection: "beacons".to_string(),
    query: Query::WithinRadius {
        center: GeoPoint::new(37.7749, -122.4194),
        radius_meters: 5000.0,
        lat_field: None,
        lon_field: None,
    },
    qos: SubscriptionQoS {
        sync_mode: SyncMode::LatestOnly,
        max_documents: Some(100),
        update_rate_ms: Some(1000),
    },
};

Fields

collection: String

Collection to subscribe to

query: Query

Query filter for documents

qos: SubscriptionQoS

QoS settings for this subscription

Implementations

impl Subscription

pub fn all(collection: impl Into<String>) -> Subscription

Create a subscription for all documents in a collection

pub fn with_query(collection: impl Into<String>, query: Query) -> Subscription

Create a subscription with a query

pub fn with_qos( collection: impl Into<String>, query: Query, qos: SubscriptionQoS, ) -> Subscription

Create a subscription with query and QoS

pub fn within_radius( collection: impl Into<String>, center: GeoPoint, radius_meters: f64, ) -> Subscription

Create a spatial radius subscription

pub fn within_bounds( collection: impl Into<String>, min: GeoPoint, max: GeoPoint, ) -> Subscription

Create a spatial bounds subscription

pub fn with_sync_mode(self, sync_mode: SyncMode) -> Subscription

Set sync mode for this subscription

pub fn update_query(&mut self, query: Query)

Update the query for this subscription

Allows modifying the subscription filter without recreating it. Useful for dynamic spatial queries that follow user position.

pub fn update_qos(&mut self, qos: SubscriptionQoS)

Update the QoS settings for this subscription

Allows adjusting sync behavior based on runtime conditions (e.g., switching to LatestOnly when bandwidth is constrained).

pub fn update_sync_mode(&mut self, sync_mode: SyncMode)

Update just the sync mode

pub fn update_center(&mut self, new_center: GeoPoint)

Update the spatial center point (for radius queries)

If the current query is a WithinRadius, updates the center point. Otherwise, this is a no-op.

pub fn update_radius(&mut self, new_radius: f64)

Update the spatial radius (for radius queries)

If the current query is a WithinRadius, updates the radius. Otherwise, this is a no-op.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.