Struct SettingsSection 

pub struct SettingsSection { /* private fields */ }

One untyped section of the desktop settings document, for the owner of a shared section (Settings, the theme store) and readers of one that has no SettingsSchema type yet. Apps keep their own preferences in a typed Settings. Reads never fail; a missing, unreadable or malformed document reads as empty. Writes merge the given keys into the section and keep every other section and key.

Implementations

impl SettingsSection

pub fn named(name: &str) -> SettingsSection

The section named name.

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

The same section in the document at path instead of the user’s (tests, tools that edit another profile).

pub fn in_document(self, document: SettingsDocument) -> SettingsSection

The same section in document: the one the host gave the app (AppStorage::settings_document).

pub fn name(&self) -> &str

The section’s name.

pub fn path(&self) -> Option<PathBuf>

Where the document is, when it is a file.

pub fn document(&self) -> Map<String, Value>

The whole desktop settings document.

pub fn load(&self) -> Map<String, Value>

The section’s keys.

pub fn bool(&self, key: &str) -> Option<bool>

One key, when present and of this type.

pub fn string(&self, key: &str) -> Option<String>

One string key, when present.

pub fn update(&self, values: Map<String, Value>) -> Result<(), Error>

Merge values into the section.

Errors

When there is no document to write or the write fails.

Trait Implementations

impl Clone for SettingsSection

fn clone(&self) -> SettingsSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsSection

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

Formats the value using the given formatter.

impl PartialEq for SettingsSection

fn eq(&self, other: &SettingsSection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SettingsSection

impl StructuralPartialEq for SettingsSection