Struct yrs::Doc

pub struct Doc { /* private fields */ }

A Yrs document type. Documents are most important units of collaborative resources management. All shared collections live within a scope of their corresponding documents. All updates are generated on per document basis (rather than individual shared type). All operations on shared collections happen via Transaction, which lifetime is also bound to a document.

Document manages so called root types, which are top-level shared types definitions (as opposed to recursively nested types).

A basic workflow sample:

use yrs::{Doc, ReadTxn, StateVector, Text, Transact, Update};
use yrs::updates::decoder::Decode;
use yrs::updates::encoder::Encode;

let doc = Doc::new();
let root = doc.get_or_insert_text("root-type-name");
let mut txn = doc.transact_mut(); // all Yrs operations happen in scope of a transaction
root.push(&mut txn, "hello world"); // append text to our collaborative document

// in order to exchange data with other documents we first need to create a state vector
let remote_doc = Doc::new();
let mut remote_txn = remote_doc.transact_mut();
let state_vector = remote_txn.state_vector().encode_v1();

// now compute a differential update based on remote document's state vector
let update = txn.encode_diff_v1(&StateVector::decode_v1(&state_vector).unwrap());

// both update and state vector are serializable, we can pass the over the wire
// now apply update to a remote document
remote_txn.apply_update(Update::decode_v1(update.as_slice()).unwrap());

Implementations

impl Doc

pub fn new() -> Self

Creates a new document with a randomized client identifier.

pub fn with_client_id(client_id: ClientID) -> Self

Creates a new document with a specified client_id. It’s up to a caller to guarantee that this identifier is unique across all communicating replicas of that document.

pub fn with_options(options: Options) -> Self

pub fn client_id(&self) -> ClientID

A unique client identifier, that’s also a unique identifier of current document replica and it’s subdocuments.

pub fn guid(&self) -> &Uuid

A globally unique identifier, that’s also a unique identifier of current document replica, and unlike Doc::client_id it’s not shared with its subdocuments.

pub fn options(&self) -> &Options

Returns config options of this Doc instance.

pub fn get_or_insert_text(&self, name: &str) -> TextRef

Returns a TextRef data structure stored under a given name. Text structures are used for collaborative text editing: they expose operations to append and remove chunks of text, which are free to execute concurrently by multiple peers over remote boundaries.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as a text (in such case a sequence component of complex data type will be interpreted as a list of text chunks).

pub fn get_or_insert_map(&self, name: &str) -> MapRef

Returns a MapRef data structure stored under a given name. Maps are used to store key-value pairs associated together. These values can be primitive data (similar but not limited to a JavaScript Object Notation) as well as other shared types (Yrs maps, arrays, text structures etc.), enabling to construct a complex recursive tree structures.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as a map (in such case a map component of complex data type will be interpreted as native map).

pub fn get_or_insert_array(&self, name: &str) -> ArrayRef

Returns an ArrayRef data structure stored under a given name. Array structures are used for storing a sequences of elements in ordered manner, positioning given element accordingly to its index.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as an array (in such case a sequence component of complex data type will be interpreted as a list of inserted values).

pub fn get_or_insert_xml_fragment(&self, name: &str) -> XmlFragmentRef

Returns a XmlFragmentRef data structure stored under a given name. XML elements represent nodes of XML document. They can contain attributes (key-value pairs, both of string type) as well as other nested XML elements or text values, which are stored in their insertion order.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as a XML element (in such case a map component of complex data type will be interpreted as map of its attributes, while a sequence component - as a list of its child XML nodes).

pub fn get_or_insert_xml_element(&self, name: &str) -> XmlElementRef

Returns a XmlElementRef data structure stored under a given name. XML elements represent nodes of XML document. They can contain attributes (key-value pairs, both of string type) as well as other nested XML elements or text values, which are stored in their insertion order.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as a XML element (in such case a map component of complex data type will be interpreted as map of its attributes, while a sequence component - as a list of its child XML nodes).

pub fn get_or_insert_xml_text(&self, name: &str) -> XmlTextRef

Returns a XmlTextRef data structure stored under a given name. Text structures are used for collaborative text editing: they expose operations to append and remove chunks of text, which are free to execute concurrently by multiple peers over remote boundaries.

If no structure under defined name existed before, it will be created and returned instead.

If a structure under defined name already existed, but its type was different it will be reinterpreted as a text (in such case a sequence component of complex data type will be interpreted as a list of text chunks).

pub fn observe_update_v1<F>(
    &self,
    f: F
) -> Result<UpdateSubscription, BorrowMutError>where
    F: Fn(&TransactionMut<'_>, &UpdateEvent) + 'static,

Subscribe callback function for any changes performed within transaction scope. These changes are encoded using lib0 v1 encoding and can be decoded using [Update::decode_v1] if necessary or passed to remote peers right away. This callback is triggered on function commit.

Returns a subscription, which will unsubscribe function when dropped.

pub fn unobserve_update_v1(&self, subscription_id: SubscriptionId)

Manually unsubscribes from a callback used in Doc::observe_update_v1 method.

pub fn observe_update_v2<F>(
    &self,
    f: F
) -> Result<UpdateSubscription, BorrowMutError>where
    F: Fn(&TransactionMut<'_>, &UpdateEvent) + 'static,

Subscribe callback function for any changes performed within transaction scope. These changes are encoded using lib0 v1 encoding and can be decoded using [Update::decode_v2] if necessary or passed to remote peers right away. This callback is triggered on function commit.

Returns a subscription, which will unsubscribe function when dropped.

pub fn unobserve_update_v2(&self, subscription_id: SubscriptionId)

Manually unsubscribes from a callback used in Doc::observe_update_v1 method.

pub fn observe_transaction_cleanup<F>(
    &self,
    f: F
) -> Result<AfterTransactionSubscription, BorrowMutError>where
    F: Fn(&TransactionMut<'_>, &AfterTransactionEvent) + 'static,

Subscribe callback function to updates on the Doc. The callback will receive state updates and deletions when a document transaction is committed.

pub fn unobserve_transaction_cleanup(&self, subscription_id: SubscriptionId)

Cancels the transaction cleanup callback associated with the subscription_id

pub fn observe_subdocs<F>(
    &self,
    f: F
) -> Result<SubdocsSubscription, BorrowMutError>where
    F: Fn(&TransactionMut<'_>, &SubdocsEvent) + 'static,

Subscribe callback function, that will be called whenever a subdocuments inserted in this Doc will request a load.

pub fn unobserve_subdocs(&self, subscription_id: SubscriptionId)

Cancels the subscription created previously using Doc::observe_subdocs.

pub fn observe_destroy<F>(
    &self,
    f: F
) -> Result<DestroySubscription, BorrowMutError>where
    F: Fn(&TransactionMut<'_>, &Doc) + 'static,

Subscribe callback function, that will be called whenever a [DocRef::destroy] has been called.

pub fn unobserve_destroy(&self, subscription_id: SubscriptionId)

Cancels the subscription created previously using Doc::observe_subdocs.

pub fn load<T>(&self, parent_txn: &mut T)where
    T: WriteTxn,

Sends a load request to a parent document. Works only if current document is a sub-document of an another document.

pub fn destroy<T>(&mut self, parent_txn: &mut T)where
    T: WriteTxn,

Starts destroy procedure for a current document, triggering an “destroy” callback and invalidating all event callback subscriptions.

pub fn parent_doc(&self) -> Option<Doc>

pub fn weak_ref(&self) -> WeakStoreRef

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Self

Returns the “default value” for a type.

impl Display for Doc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Doc> for Doc

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Prelim for Doc

fn into_content(
    self,
    _txn: &mut TransactionMut<'_>
) -> (ItemContent, Option<Self>)

This method is used to create initial content required in order to create a block item. A supplied ptr can be used to identify block that is about to be created to store the returned content.

fn integrate(self, _txn: &mut TransactionMut<'_>, _inner_ref: BranchPtr)

Method called once an original item filled with content from Self::into_content has been added to block store. This method is used by complex types such as maps or arrays to append the original contents of prelim struct into YMap, YArray etc.

impl ToJson for Doc

fn to_json<T: ReadTxn>(&self, txn: &T) -> Any

Converts all contents of a current type into a JSON-like representation.

impl Transact for Doc

fn try_transact(&self) -> Result<Transaction<'_>, TransactionAcqError>

Creates a transaction used for all kind of block store operations. Transaction cleanups & calling event handles happen when the transaction struct is dropped.

fn try_transact_mut(&self) -> Result<TransactionMut<'_>, TransactionAcqError>

Creates a transaction used for all kind of block store operations. Transaction cleanups & calling event handles happen when the transaction struct is dropped.

fn transact(&self) -> Transaction<'_>

Creates a transaction used for all kind of block store operations. Transaction cleanups & calling event handles happen when the transaction struct is dropped.

fn transact_mut(&self) -> TransactionMut<'_>

Creates a transaction used for all kind of block store operations. Transaction cleanups & calling event handles happen when the transaction struct is dropped.

impl Send for Doc

impl Sync for Doc