Struct Preferences 

pub struct Preferences { /* private fields */ }

The shared preferences as one application sees them, from Family::preferences.

use qframe::i18n::I18n;
use qframe::storage::{Family, Source};

// An application calls `Family::QUVYTA.preferences("code", &i18n)`; the example keeps to a
// folder of its own.
let prefs = Family::QUVYTA.preferences_in(&folder, "code", &I18n::builtin());
let theme = prefs.theme();
assert_eq!((theme.value.as_str(), theme.source), ("monochrome", Source::Detected), "never detected");
assert!(folder.join("quvyta.conf").is_file(), "the first start writes the shared file");

Implementations

impl Preferences

pub fn update_notice(&self) -> bool

Whether the family’s applications say when a newer version of themselves is out; see Family::update_notice. One switch for the whole family, on unless it was turned off.

pub fn language(&self) -> &Resolved<String>

The locale code to speak.

pub fn theme(&self) -> &Resolved<String>

The theme id to draw with.

pub fn icons(&self) -> &Resolved<IconMode>

The icon mode to draw with.

pub fn source(&self, key: Shared) -> Source

Where key came from.

pub fn diagnostics(&self) -> &[Diagnostic]

Problems found on the way: a broken line in the shared file, a shared file that could not be written. Each is located where a file is to blame; the key it concerns fell back to the detected value. Problems in the application’s own file are reported by the application’s own Settings load and are not repeated here.

pub fn apply<Msg: Send + 'static>(&self) -> Command<Msg>

Commands that switch the running application to the resolved language, theme and icons, for use after a change in update. At start give the preferences to Runtime::preferences instead, so the first frame is already drawn with them.

Trait Implementations

impl Clone for Preferences

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preferences

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

Formats the value using the given formatter.

impl PartialEq for Preferences

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Preferences