Struct Settings 

pub struct Settings { /* private fields */ }

typed settings over a file (see the module header)

Implementations

impl Settings

pub fn open(path: &str, schema: &'static Schema) -> Settings

the settings of a file (a missing or unreadable file: the defaults)

pub fn new(schema: &'static Schema) -> Settings

settings only in memory (save does nothing)

pub fn from_ini(ini: Ini, schema: &'static Schema) -> Settings

settings in memory, read from an Ini (migrated like a file)

pub fn schema(&self) -> &'static Schema

pub fn path(&self) -> &str

the file’s path (“” in memory)

pub fn file_version(&self) -> u32

the format version the file had before a migration (0: none / no version line)

pub fn get<T: Value>(&self, k: &Key<T>) -> T

a value (the key’s default when the key is not in the schema and not in the file)

pub fn text(&self, k: &Key<String>) -> &str

a text without copying it

pub fn set<T: Value>(&mut self, k: &Key<T>, v: T) -> bool

set a value (made valid for the key) -> it changed

pub fn reset<T>(&mut self, k: &Key<T>) -> bool

back to the default (the line leaves the file)

pub fn reset_all(&mut self) -> bool

every key of the schema back to its default

pub fn is_default<T>(&self, k: &Key<T>) -> bool

the key has its default value

pub fn at(&self, i: usize) -> &Val

the value of schema key i

pub fn default_at(&self, i: usize) -> Val

the default of schema key i

pub fn set_at(&mut self, i: usize, v: Val) -> bool

set schema key i (made valid) -> it changed

pub fn dirty(&self) -> bool

unsaved changes

pub fn revision(&self) -> u32

counts every change (redraw or apply what depends on the settings when it moved)

pub fn ini(&self) -> &Ini

the file’s data (free-form sections the schema does not describe)

pub fn ini_mut(&mut self) -> &mut Ini

change free-form data (marks the settings dirty; keys of the schema: use set)

pub fn save(&mut self) -> bool

write the file when something changed (atomic; in memory: nothing) -> ok