Struct Live 

pub struct Live<R: Resource> { /* private fields */ }

A shared handle to the current state of one resource.

The framework brings the state up to date when the document’s heads move — a local action, a collaborator’s edit, an undo — reading only what the change touched (Resource::refresh), and bumps the revision so bound widgets refresh. Views never write it: edits are actions.

A view of a large resource says what it shows with demand, and only that is read (Resource::load).

Implementations

impl<R: Resource> Live<R>

pub fn place_of(&self, participant: &ParticipantId) -> Option<Place>

Where participant’s last action left them, as the resource places it (Resource::lands): the paragraph an agent appended, the table it inserted. None before they did anything that lands somewhere.

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

The current state. Cheap: shares the materialised value.

Keep it only as long as a frame needs it. A state still shared when the document next changes cannot be updated in place, so the framework reads the whole resource again instead; read through with or call this again when you need it.

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

Read the current state.

pub fn unreadable(&self) -> Option<Unreadable>

Why the document stopped reading as the resource, if it did: the state is then the last one that read, and views show this instead.

pub fn revision(&self) -> u64

Increases whenever the state changes.

pub fn follows(&self, doc: &Doc) -> bool

Whether the state is doc as it stands: no change arrived since the framework last synced it.

pub fn demand(&self, doc: &Doc, demand: Demand) -> Result<bool, ModelError>

where R::State: Clone,

Show the parts of a large resource demand names, reading those not read yet from doc — the document the view was synced with, which in History mode is the past version on screen. Returns whether the state changed.

Errors

Returns [ModelError] when the document does not hold the resource.

pub fn current_demand(&self) -> Demand

What views currently demand.

pub fn sync(&self, doc: &Doc) -> Result<bool, ModelError>

Apply what changed in doc since the last sync, reading only what changed. The framework does this before every frame; a surface calls it after an immediate edit (Dispatcher::apply_now) to read its own result within the same event. Returns whether the state changed.

Errors

Returns [ModelError] when the document no longer holds the resource.

Trait Implementations

impl<R: Resource> Clone for Live<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.