Struct Config 

pub struct Config {
    pub editor: EditorConfig,
    pub open: OpenConfig,
    pub hooks: HooksConfig,
    pub workspace: WorkspaceConfig,
}

Top-level configuration for the worktree CLI.

Fields

editor: EditorConfig

Editor configuration.

open: OpenConfig

Workspace open behavior.

hooks: HooksConfig

Hook scripts run around the open command.

workspace: WorkspaceConfig

Workspace lifecycle configuration.

Implementations

impl Config

pub fn path() -> Result<PathBuf>

Return the path to the config file (~/.config/worktree/config.toml).

Errors

Returns an error if the home directory cannot be determined.

pub fn load() -> Result<Self>

Load config from disk, returning Default if the file does not yet exist.

Errors

Returns an error if the file cannot be read or parsed.

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

Persist the current config to disk.

Errors

Returns an error if the config directory cannot be created or the file cannot be written.

impl Config

pub fn get_value(&self, key: &str) -> Result<String>

Get a config value by dot-separated key path.

Errors

Returns an error if key is not a recognised config key.

pub fn set_value(&mut self, key: &str, value: &str) -> Result<()>

Set a config value by dot-separated key path.

Errors

Returns an error if key is not a recognised config key or if the value cannot be parsed (e.g. a non-boolean for open.editor).

impl Config

pub fn to_toml_with_comments(&self) -> String

Serialize the config to a TOML string with inline documentation comments.

Each section header and field is preceded by a # comment that matches the doc-comment on the corresponding struct field. The resulting string round-trips cleanly through toml::from_str.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.