Struct dittolive_ditto::store::collection::pending_id_specific_operation::PendingIdSpecificOperation
source · [−]pub struct PendingIdSpecificOperation { /* private fields */ }
Expand description
These objects are returned when using findByID functionality on DittoCollections. You can either call exec on the object to get an immediate return value, or you can establish either a live query or a subscription, which both work over time. A live query, established by calling observe, will notify you every time there’s an update to the document with the ID you provided in the preceding findByID call. A subscription, established by calling subscribe, will act as a signal to other peers that you would like to receive updates from them about the document with the ID you provided in the preceding findByID call. Calling observe will generate both a subscription and a live query at the same time. If you’d like to only observe local changes then you can call observeLocal. Update and remove functionality is also exposed through this object.
Implementations
sourceimpl PendingIdSpecificOperation
impl PendingIdSpecificOperation
sourcepub fn subscribe(&self) -> Subscription
pub fn subscribe(&self) -> Subscription
Enables you to subscribe to changes that occur in relation to a document. Having a subscription acts as a signal to other peers that you are interested in receiving updates when local or remote changes are made to the relevant document. The returned DittoSubscription object must be kept in scope for as long as you want to keep receiving updates.
sourcepub fn remove(&self) -> Result<(), DittoError>
pub fn remove(&self) -> Result<(), DittoError>
Remove the document with the matching ID.
sourcepub fn evict(&self) -> Result<(), DittoError>
pub fn evict(&self) -> Result<(), DittoError>
Evict the document with the matching ID.
sourcepub fn exec(&self) -> Result<BoxedDocument, DittoError>
pub fn exec(&self) -> Result<BoxedDocument, DittoError>
Execute the find operation to return the document with the matching ID.
sourcepub fn observe<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: EventHandler,
👎 Deprecated: Use observe_v2
instead
pub fn observe<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: EventHandler,
Use observe_v2
instead
Enables you to listen for changes that occur in relation to a document.
The handler
closure will be called when local or remote changes are
made to the document referenced by the find_by_id
call that precedes
the call to observe
.
The returned LiveQuery
object must be kept in scope for as long as you
want the provided handler
to be called when an update occurs.
sourcepub fn observe_local<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: EventHandler,
👎 Deprecated: Use observe_local_v2
instead
pub fn observe_local<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: EventHandler,
Use observe_local_v2
instead
Enables you to listen for changes that occur in relation to a document.
This won’t subscribe to receive changes made remotely by others and so
it will only fire updates when a local change is made. If you want to
receive remotely performed updates as well then use observe
or also
call subscribe
separately after another find_by_id
call that
references the same document ID.
The returned LiveQuery
object must be kept in scope for as long as you
want the provided handler
to be called when an update occurs.
sourcepub fn observe_v2<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: SingleDocumentEventHandler,
pub fn observe_v2<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: SingleDocumentEventHandler,
Enables you to listen for changes that occur in relation to a document.
The handler
closure will be called when local or remote changes are
made to the document referenced by the find_by_id
call that precedes
the call to observe
.
The returned LiveQuery
object must be kept in scope for as long as you
want the provided handler
to be called when an update occurs.
sourcepub fn observe_local_v2<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: SingleDocumentEventHandler,
pub fn observe_local_v2<Handler>(
&self,
handler: Handler
) -> Result<LiveQuery, DittoError> where
Handler: SingleDocumentEventHandler,
Enables you to listen for changes that occur in relation to a document.
This won’t subscribe to receive changes made remotely by others and so
it will only fire updates when a local change is made. If you want to
receive remotely performed updates as well then use observe
or also
call subscribe
separately after another find_by_id
call that
references the same document ID.
The returned LiveQuery
object must be kept in scope for as long as you
want the provided handler
to be called when an update occurs.
sourcepub fn update<Updater>(
&self,
updater: Updater
) -> Result<Vec<UpdateResult>, DittoError> where
Updater: Fn(Option<&mut BoxedDocument>),
pub fn update<Updater>(
&self,
updater: Updater
) -> Result<Vec<UpdateResult>, DittoError> where
Updater: Fn(Option<&mut BoxedDocument>),
Update the document with the matching ID.
updater
- a Fn which will be called on the selected document if found
sourcepub fn update_doc<T>(&self, new_value: &T) -> Result<(), DittoError> where
T: Serialize,
pub fn update_doc<T>(&self, new_value: &T) -> Result<(), DittoError> where
T: Serialize,
Replaces the matching document with the provided value
new_value
- A new Serializable which will replace the found document Note this actually follows “upsert” rules and will insert a document if no document is found with the given DocumentId.
Auto Trait Implementations
impl RefUnwindSafe for PendingIdSpecificOperation
impl Send for PendingIdSpecificOperation
impl Sync for PendingIdSpecificOperation
impl Unpin for PendingIdSpecificOperation
impl UnwindSafe for PendingIdSpecificOperation
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more