Struct RecordSync 

pub struct RecordSync { /* private fields */ }

A record’s replication beside one peer.

Implementations

impl RecordSync

pub fn new() -> RecordSync

pub fn delivered(heads: Vec<ChangeHash>) -> RecordSync

A record the peer already delivered as heads: what this replica sends first is what it changed after them, not the record whole again.

pub const fn snapshotted(&self) -> bool

Whether the peer holds the record whole.

pub fn advance(&mut self, heads: Vec<ChangeHash>)

The peer accepted everything up to heads.

pub fn take_outbound( &mut self, store: &RecordStore, id: &RecordId, ) -> Result<Option<Outbound>, String>

What this replica sends next: the record whole the first time, the changes the peer lacks after it, whoever made them. Advance with the returned heads once the peer accepted them.

Errors

The record is not open here or its owner is busy.

pub fn take_own( &mut self, store: &RecordStore, id: &RecordId, ) -> Result<Option<Outbound>, String>

What this replica made and the peer lacks, for a route that publishes its own changes alone (RecordStore::own_delta).

Errors

The record is not open here or its owner is busy.

pub fn merge( &mut self, store: &RecordStore, checkout: &RecordCheckout, mutation: DocumentMutation, ) -> Result<bool, String>

Merge a peer’s mutation into the open record; whether it changed. What the mutation carried is noted on the frontier, as this replica’s peers hold it already.

Errors

The bytes are not a valid mutation of this record, or it is not open.

pub fn set_aside( &mut self, store: &RecordStore, id: &RecordId, ) -> Result<(), String>

Move this replica’s own changes past the frontier and keep them for Self::take_set_aside: for a caller that publishes on its own schedule and cannot take the frontier’s heads itself.

Errors

The record is not open here or its owner is busy.

pub fn take_set_aside(&mut self) -> Option<DocumentMutation>

Everything Self::set_aside moved since the last call, as one run.

pub fn builds_on(doc: &mut AutoCommit, bytes: &[u8]) -> bool

Whether bytes build only on changes doc holds: an incremental run that builds on nothing here belongs to another record, or arrived ahead of what it builds on.

Trait Implementations

impl Default for RecordSync

fn default() -> RecordSync

Returns the “default value” for a type.