Struct Config 

pub struct Config { /* private fields */ }

QCode’s settings file.

Implementations

impl Config

pub const LANGUAGES: [&'static str; 9]

Every language QCode speaks, in the order the setup wizard offers them.

The list lives with the settings file because this is where a chosen language stops being a choice on a screen and becomes text a schema has to accept. A screen that offers a language the file will not hold writes it once and loses it at the next start, so the screens read their list from here rather than keeping one of their own.

pub const RECENT_LIMIT: usize = 10

How many workspaces the recent list keeps. Beyond a screenful the list stops being a shortcut, and the full list of workspaces is one screen away.

pub fn load() -> Loaded<Self>

Brings the settings over from where earlier versions kept them and reads them from the family’s folder. The diagnostics are the old files that stayed where they were, each with the reason; nothing was overwritten to move them. Without a home folder the settings stay in memory and say why.

pub fn load_in(folder: &Path, legacy: &Path) -> Loaded<Self>

load with folder as the family’s folder and legacy as the folder the old settings.toml may be in, so a test never touches the person’s own settings.

pub fn parse_str(file: &str, text: &str) -> Self

Reads the settings from TOML text, reporting problems against file. Saving does nothing.

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

Every problem found while reading the file, including every repair that was made.

pub fn is_clean(&self) -> bool

Whether the file was read without a single problem.

pub fn to_toml(&self) -> String

The settings as TOML text, which is what saving writes.

pub fn save(&mut self) -> Result<()>

Writes the settings to their file atomically.

Errors

Returns the I/O error when the directory or the file cannot be written.

pub fn settings(&self) -> &Settings

The framework settings underneath, for the screens that read the theme, the language or the icon mode and for applying them.

pub fn set_language(&mut self, code: &str) -> bool

Records the language the application speaks. Answers whether anything changed.

The four settings the framework keeps for every Quvyta application are already in force by the time they reach here: the settings screen applies a choice to the running application and asks for it to be stored, and storing is this file’s part of that.

pub fn set_theme(&mut self, id: &str) -> bool

Records the theme the application wears. Answers whether anything changed.

pub fn set_icons(&mut self, mode: IconMode) -> bool

Records which glyphs the application draws with. Answers whether anything changed.

pub fn set_reduced_motion(&mut self, reduced: bool) -> bool

Records whether the application moves as little as it can. Answers whether anything changed.

pub fn setup_completed(&self) -> bool

Whether the setup wizard has finished. Until it has, the wizard runs.

pub fn set_setup_completed(&mut self, completed: bool) -> bool

Records whether the setup wizard has finished. Answers whether anything changed.

pub fn setup_step(&self) -> SetupStep

The step the wizard stopped at, the first one until it says otherwise.

pub fn set_setup_step(&mut self, step: SetupStep) -> bool

Records the step the wizard is on. Answers whether anything changed.

pub fn engine_kind(&self) -> Option<&str>

The chosen container engine, as the engine layer names it, or None while the user has not chosen one.

pub fn set_engine_kind(&mut self, kind: &str) -> bool

Records the chosen engine. A word no engine answers to is refused rather than stored.

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

Where the store lives, once the wizard has placed it.

pub fn set_folder_path(&mut self, path: &Path) -> bool

Records where the store lives. A relative path is refused: it would mean something different in every working directory the application is started from.

pub fn on_close(&self) -> OnClose

What happens to QCode’s containers once no QCode is open, stopping them until the person says otherwise.

pub fn set_on_close(&mut self, choice: OnClose) -> bool

Records what happens to the containers once no QCode is open. Answers whether anything changed.

Choosing the default takes the key out of the file rather than writing the default in, so a later change of the default reaches this installation too.

pub fn backup_every(&self) -> BackupEvery

How often an open workspace is backed up, every fifteen minutes until the person says otherwise.

pub fn set_backup_every(&mut self, choice: BackupEvery) -> bool

Records how often an open workspace is backed up. Answers whether anything changed.

Like set_on_close, choosing the default takes the key out of the file.

pub fn recent_workspaces(&self) -> Vec<WorkspaceId>

The workspaces that were opened last, newest first.

pub fn remember_workspace(&mut self, id: &WorkspaceId)

Moves a workspace to the front of the recent list, dropping the oldest beyond RECENT_LIMIT.

pub fn forget_workspace(&mut self, id: &WorkspaceId)

Takes a workspace out of the recent list, for one that is gone or was deleted.

pub fn editor(&self) -> Editor

The editor a text file opens in; nano until the person chooses otherwise.

pub fn set_editor(&mut self, editor: Editor) -> bool

Records the editor a text file opens in. Answers whether anything changed.

Choosing nano again takes the key out rather than writing the default down, so the file of a person who went back to the default is the file of one who never left it.

pub fn sound(&self) -> Sound

What opening a sound does; it plays until the person chooses otherwise.

pub fn set_sound(&mut self, sound: Sound) -> bool

Records what opening a sound does. Answers whether anything changed.

Playing is the default and is taken out rather than written down, as with the editor.

pub fn ask_first(&self) -> bool

Whether the person is asked before one tab’s agent sends its first message to another. Off until the person turns it on.

pub fn set_ask_first(&mut self, ask: bool) -> bool

Records whether the person is asked before the first message between two tabs. Answers whether anything changed.

Not asking is the default and is taken out rather than written down, as with the editor.

pub fn freeze_idle(&self) -> bool

Whether a profile whose container is doing nothing is frozen in the background, and its memory written out to swap. On until the person turns it off.

pub fn set_freeze_idle(&mut self, freeze: bool) -> bool

Records whether a quiet profile’s container is frozen in the background. Answers whether anything changed.

Freezing is the default and is taken out of the file rather than written down, so the file of a person who turned it back on is the file of one who never turned it off.

Trait Implementations

impl Clone for Config

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 Config

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

Formats the value using the given formatter.