View Source Yex (y_ex v0.0.3)
Documentation for Yex
.
Summary
Functions
Apply a document update on the shared document.
Encode the document state as a single update message that can be applied on the remote document. Optionally, specify the target state vector to only write the missing differences to the update message.
Computes the state vector and encodes it into an Uint8Array. A state vector describes the state of the local client. The remote client can use this to exchange only the missing differences.
Functions
Apply a document update on the shared document.
Examples Sync two clients by exchanging the complete document structure
iex> doc1 = Yex.Doc.new()
iex> doc2 = Yex.Doc.new()
iex> {:ok, state1} = Yex.encode_state_as_update(doc1)
iex> {:ok, state2} = Yex.encode_state_as_update(doc2)
iex> Yex.apply_update(doc1, state2)
:ok
iex> Yex.apply_update(doc2, state1)
:ok
Encode the document state as a single update message that can be applied on the remote document. Optionally, specify the target state vector to only write the missing differences to the update message.
Examples
iex> doc = Yex.Doc.new()
iex> Yex.encode_state_as_update(doc)
{:ok, <<0, 0>>}
Computes the state vector and encodes it into an Uint8Array. A state vector describes the state of the local client. The remote client can use this to exchange only the missing differences.
Examples
iex> doc = Yex.Doc.new()
iex> Yex.encode_state_vector(doc)
{:ok, <<0>>}