Enum SettingsDocument 

pub enum SettingsDocument {
    Session,
    File(PathBuf),
}

Which settings document a host gives its apps.

Variants

Session

The person’s session document: the one the host installed (settings_store::install_source), else the local settings.json.

File(PathBuf)

A document file of the host’s own: a test or capture profile.

Implementations

impl SettingsDocument

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

Where the document is, when it is a file.

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

The whole document.

pub fn section(&self, name: &str) -> Map<String, Value>

One section’s keys.

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

Merge values into section name, keeping every other section and key.

Errors

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

pub fn update_section_by( &self, name: &str, values: Map<String, Value>, origin: Option<&ChangeOrigin>, ) -> Result<(), Error>

Self::update_section, recording who and what made the change with every key it changes, where the document keeps a history of its changes (the session’s).

Errors

As Self::update_section.

pub fn revision(&self) -> SettingsRevision

The document’s current version.

Trait Implementations

impl Clone for SettingsDocument

fn clone(&self) -> SettingsDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsDocument

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

Formats the value using the given formatter.

impl Default for SettingsDocument

fn default() -> SettingsDocument

Returns the “default value” for a type.

impl PartialEq for SettingsDocument

fn eq(&self, other: &SettingsDocument) -> 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 SettingsDocument

impl StructuralPartialEq for SettingsDocument