Struct Cx 

pub struct Cx<'a, D: Document> {
    pub jobs: &'a mut Jobs<Session<D>>,
    pub toasts: &'a mut Toasts,
    pub settings: &'a mut Settings,
    /* private fields */
}

What the view gets each frame: the session, commands, jobs, toasts and settings.

Fields

jobs: &'a mut Jobs<Session<D>>

Background work; a job’s apply runs on the session (each edit there is an undo step).

toasts: &'a mut Toasts

settings: &'a mut Settings

App settings (debounced, saved in the config folder).

Implementations

impl<D: Document> Cx<'_, D>

pub fn doc(&self) -> &D

The current document.

pub fn snapshot(&self) -> Arc<D>

The current document as an Arc (to keep while calling &mut self methods).

pub fn revision(&self) -> Revision

The revision of the current document (key caches by it).

pub fn session(&self) -> &Session<D>

pub fn session_mut(&mut self) -> &mut Session<D>

pub fn ctx(&self) -> &Context

pub fn dispatch(&mut self, id: &str, params: Value)

Run a command after the view returns (menus, buttons). Errors are shown as toasts.

pub fn execute( &mut self, id: &str, params: Value, ) -> Result<Value, CommandError>

Run a command now and get its result.

pub fn edit<R>(&mut self, label: &str, f: impl FnOnce(&mut D) -> R) -> R

An undoable change made directly by the view (one step called label).

pub fn edit_merged<R>( &mut self, label: &str, merge_key: &str, f: impl FnOnce(&mut D) -> R, ) -> R

An undoable change folded into the previous one with the same label and key (a drag).

pub fn view<T: DeserializeOwned>(&self, key: &str) -> Option<T>

View state (not in the document; ui.set changes it too).

pub fn view_or<T: DeserializeOwned>(&self, key: &str, default: T) -> T

pub fn set_view<T: Serialize + ?Sized>(&mut self, key: &str, value: &T)