View Source Yex.Sync (y_ex v0.6.3)
Sync protocol.
Summary
Functions
Create a sync step 1 message based on the state of the current shared document.
Decode a message.
Encode a message.
Types
@type message() :: {:sync, sync_message()} | :query_awareness | {:awareness, message()} | {:auth, term()}
Functions
Create a sync step 1 message based on the state of the current shared document.
Decode a message.
Examples
iex> Yex.Sync.message_decode(<<0, 0, 1,0>>)
{:ok, {:sync, {:sync_step1, <<0>>}}}
Encode a message.
Examples
iex> Yex.Sync.message_encode({:sync, {:sync_step1, <<0>>}})
{:ok, <<0, 0, 1,0>>}
@spec read_sync_message(sync_message(), Yex.Doc.t(), term()) :: {:ok, term()} | {:error, term()}