Struct PersonRecord 

pub struct PersonRecord<P: Resource> { /* private fields */ }

A resource of the person’s own, kept in their own room: what they watched, the words they taught the keyboard, where they stopped reading. It follows them to their other devices and never reaches a collaborator, whatever room the app is open in.

It is a resource like the app’s own: its edits are its actions, applied by the replayable executor, attributed to the person, written into its history and undone per step (Self::undo). One record per resource kind and app, the same on every device, created with the resource’s genesis (Resource::initialize) where it does not exist yet. Read it through Self::state or Self::with; an edit from another window or device reaches it on the next frame.

Implementations

impl<P: Resource> PersonRecord<P>

pub fn get(&self) -> Rc<P::State>

The current state.

pub fn with<T>(&self, read: impl FnOnce(&P::State) -> T) -> T

Read the current state.

pub fn state(&self) -> LocalState<Rc<P::State>>

The state as view state that follows every change, for a control bound to it.

pub fn revision(&self) -> u64

Increases whenever the state changes.

pub fn apply(&self, action: &P::Action) -> Result<(), ActionError>

Apply action now: one change of the record, attributed to the person, recorded in its history and — for content the person made — one undo step of theirs.

Errors

The action refused to apply, or the record is unavailable.

pub fn invoke(&self, invoke: &Invoke<P>) -> Result<(), ActionError>

Apply the action invoke names, as Self::apply.

Errors

The arguments do not build the action, or it refused to apply.

pub fn editable(&self) -> bool

Whether this app changes the record: its own, or a shared one it is an editor of; any other is read here.

pub fn undo(&self) -> bool

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

pub fn redo(&self) -> bool

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

pub fn syncs(&self) -> bool

Whether the record reaches the person’s other devices: they have a root identity, so it lives in their room. Without one it is kept on this device only.

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

Where the content this record references — a picture its state names by hash — is stored and read. It lives with the record, on the person’s devices, never in the room of the window showing it; None on a device that knows no person, whose records keep no content.

pub fn record(&self) -> &StoredRecord

The record underneath, for a test or host that carries it between devices itself.

Trait Implementations

impl<P: Resource> Clone for PersonRecord<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.