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

source · [−]
pub trait DittoMutDocument: DittoDocument {
    fn get_mut<V: MutableValue>(&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 push<V: Serialize>(
        &mut self, 
        path: &str, 
        val: V
    ) -> Result<(), DittoError>;

    fn pop<T>(&mut self, path: &str) -> Result<T, DittoError>
    where
        T: DeserializeOwned;

    fn insert<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>;
}

Required methods

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.

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.

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

Given a path to an array inside a document, appends value to the array. An error will be returned if the path does not in fact point to an array.

Removes and returns the last item at a path within a document if that path is to an array.

Inserts a value at the provided path and *will not remove other descendant items at that path.

Remove the value from a document at a given path

Increment (+/-) a field previously transformed into a Counter by amount.

Implementors