Enum SettingsDocument 

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

Which settings document a host gives its apps.

Variants

Session

The person’s session settings: the source the host installed (settings_store::install_source), else the local profile.

Profile(PathBuf)

The settings of a profile of the host’s own, by its root directory: a test or capture profile.

Implementations

impl SettingsDocument

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

The configuration directory of the profile this document belongs to: the person’s config root for the session document, else the profile’s own root. Per-profile stores beside the settings (accounts, their credentials and sync health) live here, so a test, capture or --data-dir profile never reads or writes the person’s.

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.

Errors

As Self::update_section.

pub fn revision(&self) -> SettingsRevision

The document’s current version.

pub fn edit_document( &self, name: &str, origin: &ChangeOrigin, edit: impl FnOnce(&mut AutoCommit) -> Result<(), String>, ) -> Result<(), Error>

Change the document holding section name itself through edit, as one change made by origin: what a change reading the document’s history makes (a section’s undo). See settings_store::Store::edit_document.

Errors

edit refused, the write failed, or this process holds only the values of the settings (an app’s channel to the session’s), not the document.

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 Ord for SettingsDocument

fn cmp(&self, other: &SettingsDocument) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for SettingsDocument

fn partial_cmp(&self, other: &SettingsDocument) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SettingsDocument

impl StructuralPartialEq for SettingsDocument