Skip to main content

JsonDoc

Struct JsonDoc 

Source
pub struct JsonDoc { /* private fields */ }
Expand description

A collaborative JSON document.

Implementations§

Source§

impl JsonDoc

Source

pub fn new(id: impl Into<String>, replica_id: impl Into<String>) -> Self

Create a new JSON CRDT document.

Source

pub fn set(&mut self, path: &str, value: JsonValue)

Set a value at a dot-path (for example, "profile.name").

Source

pub fn get(&self, path: &str) -> Option<JsonValue>

Get a value at a dot-path.

Source

pub fn delete(&mut self, path: &str)

Delete a value at a dot-path.

Source

pub fn root(&self) -> Value

Return the entire document as serde_json::Value.

Source

pub fn keys(&self) -> Vec<String>

Return top-level keys in the JSON object.

Source

pub fn merge(&mut self, other: &JsonDoc)

Merge another replica state into this document.

This is a commutative CRDT join, so order does not affect convergence.

Source

pub fn clone_state(&self) -> JsonDoc

Clone this document’s state for synchronization.

The returned state clears local pending delta buffers.

Trait Implementations§

Source§

impl Clone for JsonDoc

Source§

fn clone(&self) -> JsonDoc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CollaborativeDoc for JsonDoc

Source§

fn id(&self) -> &str

Return the stable document identifier.
Source§

fn replica_id(&self) -> &str

Return the local replica identifier that owns this document handle.
Source§

fn subscribe(&self) -> Receiver<DocEvent>

Subscribe to document change events. Read more
Source§

fn take_pending_deltas(&mut self) -> Vec<Vec<u8>>

Drain pending deltas to send through your sync transport.
Source§

fn apply_remote(&mut self, _delta: &[u8])

Apply a serialized remote delta payload.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V