Struct WorkspaceRecord 

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

A record every app of the window’s workspace opens, held for the window (RecordEnv::workspace).

Implementations

impl<P: Resource> WorkspaceRecord<P>

pub fn open( records: &WorkspaceRecords, owner: &'static str, app: (&'static str, &'static str), permissions: Option<LivePermissions>, wake: Option<WakeHandle>, ) -> Option<Self>

The record P that owner keeps in the workspace records opens, created with the resource’s genesis where nothing holds it yet and brought to its version: what an app window holds (RecordEnv::workspace), and what a host that is no app window (the session’s workspace settings) opens the same way. Changes are attributed to app (its id and title) and, where the host knows the workspace’s grants as permissions, decided by them first; wake is woken when another replica’s change arrives.

pub fn open_at( records: &WorkspaceRecords, owner: &'static str, id: &str, app: (&'static str, &'static str), permissions: Option<LivePermissions>, wake: Option<WakeHandle>, ) -> Option<Self>

Self::open of the record id of kind P that owner keeps: a record of the owner’s that the workspace names otherwise than Self::open’s, such as a conversation’s, which the two people it is between name. The workspace’s grants decide its changes like any other.

pub fn open_primary( records: &WorkspaceRecords, owner: &'static str, app: (&'static str, &'static str), permissions: Option<LivePermissions>, wake: Option<WakeHandle>, ) -> Option<Self>

Self::open_at of the record owner keeps as its own primary one of P::KIND in the workspace: the record an app keeps as itself (Chat’s of its chat, chat.workspace), which open_record cannot open because the package’s primary id is a sentinel no [RecordId::parse] accepts. An app’s own window opens it this way; so does the session, reading the conversations its agents answer in.

pub fn id(&self) -> &RecordId

The record’s id, which names it in the workspace.

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

The current state.

pub fn revision(&self) -> u64

Increases whenever the state changes.

pub fn me(&self) -> &str

The person who acts here.

pub fn may(&self, verb: &str) -> bool

Whether the workspace’s grants let the person invoke the verb verb of the record, as its owner publishes it. A window that knows nothing of the workspace’s grants (a test host) lets the record decide.

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

Apply the action invoke names: decided by the workspace’s grants on the owner’s node, then one change of the record, attributed to the person, in its history and one undo step of theirs.

Errors

The arguments do not build the action, the grants refuse it, the record does, or the record cannot be changed right now (for that, Self::invoke_then waits).

pub fn invoke_then( &self, invoke: &Invoke<P>, then: impl FnOnce(Result<(), ActionError>) + 'static, )

Self::invoke, and then with what became of it: at once, or, where the record cannot be changed right now (its store in use by whatever runs as this is asked), once it can, on a refresh of the window. Actions that wait are applied in the order they were asked for, after the ones that waited before them.

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 WorkspaceRecord<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.