Struct Config

pub struct Config { /* private fields */ }

Wrapper around the config values stored on disk for Git.

Implementations

impl Config

pub fn open(path: &Path) -> Result<Self>

Open a configuration instance backed by the provided file. Unlike a configuration instance opened directly from the Git repository, this instance won’t have a chain of parent configuration files to fall back to for entry lookup.

pub fn open_default() -> Result<Self>

Open a configuration instance derived from the global, XDG and system configuration files.

Trait Implementations

impl ConfigRead for Config

fn get<V: GetConfigValue<V>, S: AsRef<str>>(&self, key: S) -> Result<Option<V>>

Get a config key of one of various possible types.

fn into_config(self) -> Self

Convert this object into an owned, writable version of the configuration. You should only use this if you know that it’s safe to write to the underlying configuration file.

fn list<S: AsRef<str>>(&self, glob_pattern: S) -> Result<Vec<(String, String)>>

Get all config key-value pairs matching a certain glob pattern.

fn get_or<V: GetConfigValue<V>, S: AsRef<str>>( &self, key: S, default: V, ) -> Result<V>

Same as get, but uses a default value if the config key doesn’t exist.

fn get_or_else<V: GetConfigValue<V>, S: AsRef<str>, F: FnOnce() -> V>( &self, key: S, default: F, ) -> Result<V>

Same as get, but computes a default value if the config key doesn’t exist.

impl ConfigWrite for Config

fn set( &mut self, key: impl AsRef<str>, value: impl Into<ConfigValue>, ) -> Result<()>

Set the given config key to the given value.

fn remove(&mut self, key: impl AsRef<str>) -> Result<()>

Remove the given key from the configuration.

fn set_multivar( &mut self, key: impl AsRef<str>, regex: impl AsRef<str>, value: impl AsRef<str>, ) -> Result<()>

Add or set a multivariable entry with the given to the given value. If a key-value pair whose value matches the provided regex already exists, that entry is overwritten.

fn remove_multivar( &mut self, key: impl AsRef<str>, regex: impl AsRef<str>, ) -> Result<()>

Remove the multivariable entry with the provided key and whose value matches the provided regex. If such a key is not present, does nothing.

impl Debug for Config

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

Formats the value using the given formatter.

impl From<Config> for Config

fn from(config: Config) -> Self

Converts to this type from the input type.