Struct dittolive_ditto::store::live_query::LiveQuery

pub struct LiveQuery {
    pub query: Box,
    pub collection_name: Box,
    pub subscription: Option<Box<Subscription>>,
    pub id: i64,
    /* private fields */
}

The type that is returned when calling when calling observe_local on a DittoPendingCursorOperation object. It handles the logic for calling the event handler that is provided to observe_local calls. LiveQuery objects must be kept in scope for as long as you wish to have your event handler be called when there is an update to a document matching the query you provide.

Fields

query: Box

collection_name: Box

subscription: Option<Box<Subscription>>

id: i64

Implementations

impl LiveQuery

pub fn with_handler<F>(
    ditto: Weak<BoxedDitto>,
    query: Box,
    query_args: Option<Vec<u8>>,
    collection_name: Box,
    order_by: &[COrderByParam<'_>],
    limit: i32,
    offset: u32,
    event_handler: F
) -> Result<Self, DittoError>where
    F: EventHandler,

Trait Implementations

impl Drop for LiveQuery

fn drop(self: &mut LiveQuery)

Executes the destructor for this type.

impl Observer for LiveQuery

fn stop(self)

Stop the observer so that it no longer receive updates