Struct Settings 

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

An app’s typed settings of one SettingsSchema type, in the settings document its host gave it. Get one from HostContext::settings, AppStorage::settings, or a framework view’s cx.settings::<T>().

Implementations

impl<T> Settings<T>

where T: SettingsSchema,

pub fn for_app(app_id: &str) -> Settings<T>

The settings of the app with this id, in the session document.

pub fn shared() -> Settings<T>

A Scope::Shared section, for code that serves every app (the toolkit’s text fields reading text_assistance).

pub fn in_document(self, document: SettingsDocument) -> Settings<T>

The same settings in document instead.

pub fn in_file(self, path: impl Into<PathBuf>) -> Settings<T>

The same settings in the document file at path instead.

pub const fn scope(&self) -> Scope

How far these settings travel.

pub fn document(&self) -> &SettingsDocument

The document they live in.

pub fn app_id(&self) -> &str

The app whose settings these are (empty for a shared section).

pub fn get(&self) -> T

The current value.

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

Store value. Keys of the section that T does not name are kept.

Errors

When value does not serialize to an object, a personal section would outgrow what the device fabric carries, there is no document to write, or the write fails.

pub fn set_by( &self, value: &T, origin: Option<&ChangeOrigin>, ) -> Result<(), Error>

Self::set, recording origin — the action and who invoked it — in the document’s history of who changed which setting.

Errors

As Self::set.

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

Change the current value with change and store it, returning what was stored.

Errors

As Self::set.

pub fn revision(&self) -> SettingsRevision

The document’s current version: when it changes, Self::get may answer differently.

Trait Implementations

impl<T> Clone for Settings<T>

fn clone(&self) -> Settings<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Settings<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.