Struct Setting 

pub struct Setting<T> { /* private fields */ }

One typed settings value, kept current while the view lives: a write from this window, another window, the Settings app or another of the person’s devices (for Scope::Personal) reaches Self::state on the next frame.

Bind controls to Self::state and write with Self::set. Settings are not the document: they are not undone and never seen by collaborators.

A section that is a resource model (#[derive(Model)] and an empty #[resource]) is also a record its views edit by path (ViewCx::record): its field edits and verbs are published as settings:<kind>, each change is checked by the model’s invariants and recorded in the settings document with what made it and who.

Implementations

impl<T: SettingsSchema + Clone + PartialEq + Send + Sync> Setting<T>

pub fn get(&self) -> T

The current value.

pub fn state(&self) -> LocalState<T>

The value as state that follows every write.

pub fn set(&self, value: T) -> Result<()>

Store value.

Errors

When the document refuses it (see Settings::set); the value shown stays the stored one.

pub fn update(&self, change: impl FnOnce(&mut T)) -> Result<()>

Change the stored value with change.

Errors

As Self::set.

pub fn settings(&self) -> &Settings<T>

The underlying settings, for code that runs off the view (a job).

Trait Implementations

impl<T> Clone for Setting<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.