Trait dittolive_ditto::store::collection::document::DittoMutDocument

pub trait DittoMutDocument: DittoDocument {
    // Required methods
    fn get_mut<'doc, V: MutableValue<'doc>>(
        &'doc mut self,
        path: &str
    ) -> Result<V, DittoError>;
    fn set<V: Serialize>(
        &mut self,
        path: &str,
        val: V
    ) -> Result<(), DittoError>;
    fn set_as_default<V: Serialize>(
        &mut self,
        path: &str,
        val: V
    ) -> Result<(), DittoError>;
    fn remove(&mut self, path: &str) -> Result<(), DittoError>;
    fn increment(&mut self, path: &str, amount: f64) -> Result<(), DittoError>;
}

DittoMutDocuments can be obtained within update calls (PendingIdSpecificOperation::update or PendingCursorSpecificOperation::update).

Required Methods

fn get_mut<'doc, V: MutableValue<'doc>>( &'doc mut self, path: &str ) -> Result<V, DittoError>

Returns the value at a given path in the mutable document.

The parameter V represents the type expected at the given path. Note however that other peers may have changed this type and deserialization may fail.

fn set<V: Serialize>(&mut self, path: &str, val: V) -> Result<(), DittoError>

Assigns a some serializable value to the document at the given path and removes any other information present at that path.

If the path does not exist it will be created.

fn set_as_default<V: Serialize>( &mut self, path: &str, val: V ) -> Result<(), DittoError>

Sets the value at the provided path and marks it as the default, indicating other peers in the network are expected to overwrite it.

fn remove(&mut self, path: &str) -> Result<(), DittoError>

Remove the value from a document at a given path

fn increment(&mut self, path: &str, amount: f64) -> Result<(), DittoError>

Increment (+/-) a counter by amount.

Object Safety

This trait is not object safe.

Implementors

impl<T: BorrowMut<Document>> DittoMutDocument for T