Struct PersonRecord 

pub struct PersonRecord { /* private fields */ }

One of the person’s records, open. Edits are attributed to the person, recorded as undo steps of their own and synced on the record’s route.

Implementations

impl PersonRecord

pub fn checkout(&self) -> &RecordCheckout

The record’s identity.

pub fn read<T>(&self, read: impl FnOnce(&AutoCommit) -> T) -> Option<T>

Read the record’s document; None while its owner is busy.

pub fn heads(&self) -> Vec<ChangeHash>

The record’s heads: they change with every edit here or merged from another device.

pub fn edit<T>( &self, undoable: bool, edit: impl FnOnce(&mut AutoCommit) -> Result<T, String>, ) -> Result<T, String>

Edit the record: edit changes the document, written and synced like any edit. An undoable change is one undo step of the person’s; another (content from outside, housekeeping) is nobody’s.

Errors

The record is busy, or edit failed (nothing is recorded then).

pub fn undo(&self) -> bool

Undo the person’s last edit of this record. Whether there was one.

pub fn redo(&self) -> bool

Redo the person’s last undone edit of this record.

pub fn route(&self) -> Option<RouteSpec>

The route this record syncs on: the person’s room, when they have one. None for a record kept on this device only.

pub fn syncs(&self) -> bool

Whether this record syncs to the person’s other devices.

pub fn history_owner(&self) -> HistoryOwner

The record’s owner for its collaboration route, which a widget reports from Widget::record_owners so the runtime publishes its edits and merges the person’s other devices’ while it is open.

pub fn merge_peer_document(&self, document: Vec<u8>) -> Result<bool, String>

Merge a whole document of this record another device holds, as its route would. For hosts and tests that carry the record themselves.

Errors

The bytes are not this record’s document.

pub fn document(&self) -> Option<Vec<u8>>

The whole record, as this device would send it to another.

pub fn flush(&self)

Write out what is not stored yet.

pub fn content(&self) -> Option<ContentStore>

Where the content this record references is stored and read: under the person’s own room, kept by the host and carried to the person’s other devices on the record’s route — never in the room of the window showing it. None without a person room, where the record stays on this device and keeps no content of its own.