Struct AppSettings 

pub struct AppSettings {

    pub config_version: u32,
    pub workspace_config: Option<WorkspaceConfig>,
    pub theme: String,
    pub cache_dir: PathBuf,
    pub history_dir: PathBuf,
    pub key_bindings: KeyBindings,
    pub autosave_interval_secs: u64,
    pub leader_timeout_ms: u64,
    pub leader: LeaderConfig,
    pub use_nerd_fonts: bool,
    pub editor_backend: EditorBackendSetting,
    pub nvim_path: Option<PathBuf>,
    pub default_sort_field: SortFieldSetting,
    pub default_sort_order: SortOrderSetting,
    pub journal_sort_field: SortFieldSetting,
    pub journal_sort_order: SortOrderSetting,
    pub group_directories: bool,
    pub config_file: Option<PathBuf>,
    /* private fields */
}

Fields

config_version: u32

workspace_config: Option<WorkspaceConfig>

theme: String

cache_dir: PathBuf

As written in the config file — may be relative, may start with ~.

history_dir: PathBuf

As written in the config file — see Self::cache_dir.

key_bindings: KeyBindings

autosave_interval_secs: u64

leader_timeout_ms: u64

Hesitation timeout (ms) before the which-key overlay reveals itself during a pending leader sequence. Sequences typed faster never wait.

leader: LeaderConfig

Leader-tree customization: [leader.bind] sequence→action-id overrides and [leader.labels] group captions. Applied over the built-in tree.

use_nerd_fonts: bool

editor_backend: EditorBackendSetting

nvim_path: Option<PathBuf>

default_sort_field: SortFieldSetting

default_sort_order: SortOrderSetting

journal_sort_field: SortFieldSetting

journal_sort_order: SortOrderSetting

group_directories: bool

config_file: Option<PathBuf>

Custom config file path. None means use the default location. Not serialized — it’s a runtime-only override.

Implementations

impl AppSettings

pub fn default_workspace_suggestion() -> Option<PathBuf>

Suggested directory for a first workspace (~/kimun-notes). None when the home directory cannot be determined.

pub fn leader_tree(&self) -> LeaderNode

The leader tree with this config’s [leader] overrides applied — the ONE constructor every surface (engine, which-key, cheatsheet, palette) must use, so they can never disagree.

impl AppSettings

pub fn theme_list(&self) -> Vec<Theme>

pub fn update_check(&self) -> bool

Whether the startup update check is enabled. Lives in GlobalConfig; defaults to on when no workspace config exists yet. Single source for the four read sites (startup, preferences, onboarding).

pub fn mouse(&self) -> bool

Whether kimün captures the mouse for in-app use; defaults on when no workspace config exists yet. Read at startup (main.rs) and in preferences.

pub fn save_to_disk(&self) -> Result<(), SettingsError>

pub fn load_from_disk() -> Result<Self, SettingsError>

pub fn load_from_file(path: PathBuf) -> Result<Self, SettingsError>

pub fn set_workspace_path(&mut self, name: &str, workspace_path: PathBuf)

Points the selected workspace entry at workspace_path, flagging a reindex when that actually changes where its notes are.

name is the entry to repoint; a name with no entry is a no-op.

pub fn clear_workspace(&mut self)

Removes the active workspace entry so the user is prompted to choose a new one.

Only the currently active entry is removed; other workspace entries are preserved. After this call, workspace_config remains Some but get_current_workspace() returns None.

Deliberately leaves the index and history on disk: the caller for this is a vault the app could not open (a case conflict it wants fixed), and the user is expected to re-add the same workspace once they have. See crate::settings::delete_artifacts for the deletion that goes with an intentional “remove this workspace”.

pub fn resolve_workspace_path(&self) -> Option<SystemPath>

Resolve the active workspace’s path. Returns None if no workspace is configured.

pub fn set_theme(&mut self, theme: String)

pub fn report_indexed(&mut self)

pub fn needs_indexing(&self) -> bool

pub fn add_path_history(&mut self, note_path: &VaultPath)

pub fn current_workspace_name(&self) -> Option<String>

pub fn cache_dir_resolved(&self) -> &SystemPath

The directory workspace cache files live in.

pub fn history_dir_resolved(&self) -> &SystemPath

The directory workspace history files live in.

pub fn index_for(&self, workspace_name: &str) -> IndexFile

The named workspace’s index file.

Returns the artifact, not a path: what the file is called, and that it carries -wal/-shm siblings, is IndexFile’s business. Caller must have already validated workspace_name via kimun_core::nfs::filename::validate_filename.

pub fn history_for(&self, workspace_name: &str) -> HistoryFile

The named workspace’s history file — the artifact, not a path, for the same reason as Self::index_for. Caller must have already validated workspace_name.

pub fn workspace_artifacts( &self, workspace_name: &str, ) -> (IndexFile, HistoryFile)

Everything on disk that belongs to the named workspace.

Must be read before the entry is dropped from workspace_config: both file names come from its file_key, so removing the entry first strands them under a name nothing can map back to a workspace. Pure and cheap, so the caller can take these, release the settings lock, and do the deleting outside it — see delete_artifacts.

pub fn current_last_paths(&self) -> Vec<VaultPath>

Returns the last-visited paths for the current workspace.

pub fn icons(&self) -> Icons

Build the icon set for the current use_nerd_fonts setting.

pub fn yank_combos(&self) -> Vec<KeyCombo>

The chords bound to ActionShortcuts::YankRow, for handing to a SearchList so a rebinding reaches the list surfaces. Empty when the user unbound it.

pub fn effective_theme_name(&self) -> String

Name of the theme the app is effectively using: the configured name, or the default theme’s name when none is configured. Single owner of the empty-name fallback rule — use this instead of re-deriving it.

pub fn get_theme(&self) -> Theme

Resolve the active theme by name, falling back to the default.

The resolved theme is adapted to the terminal’s color depth (truecolor themes are quantized on 256-color terminals and mapped to role-semantic ANSI slots on 16-color terminals).

Trait Implementations

impl Clone for AppSettings

fn clone(&self) -> AppSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppSettings

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

Formats the value using the given formatter.

impl Default for AppSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AppSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AppSettings

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AppSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AppSettings