Skip to main content

Config

Struct Config 

Source
pub struct Config<'repo> { /* private fields */ }
Expand description

Read merged config and update the repository-local config file.

Implementations§

Source§

impl<'repo> Config<'repo>

Source

pub fn new(repo: &'repo Repository) -> Self

Bind config operations to repo.

Source

pub fn repository(&self) -> &'repo Repository

Underlying repository.

Source

pub fn snapshot(&self) -> Result<Arc<ConfigSet>>

Shared merged config snapshot for this repository.

§Errors

Propagates config load failures.

§Examples
use grit_lib::repo::{InitOptions, Repository};
let dir = std::env::temp_dir().join("grit-config-get-doc");
let (repo, _) = Repository::init(&dir, &InitOptions::default())?;
let _ = repo.config().get("core.repositoryformatversion")?;
Source

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

Look up a merged config value (system / global / local / worktree cascade).

§Errors

Propagates config load failures and crate::error::ConfigError::InvalidKey for malformed keys.

Source

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

All values for key in load order.

Source

pub fn get_bool(&self, key: &str) -> Result<Option<bool>>

Parse a boolean config value.

Source

pub fn get_i64(&self, key: &str) -> Result<Option<i64>>

Parse an integer config value (Git k/m/g suffixes supported).

Source

pub fn get_path(&self, key: &str) -> Result<Option<PathBuf>>

Expand a path config value using this repository’s environment.

Source

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

Parse a Git color value (#rgb, normal, bold, etc.).

Source

pub fn entries_under(&self, prefix: &str) -> Result<Vec<ConfigEntry>>

Entries whose canonical key starts with prefix (a full key, a section such as remote.origin, or a section prefix ending in .).

§Errors

Config load failures, and crate::error::ConfigError when prefix is empty or invalid.

Source

pub fn mailmap(&self) -> Result<MailmapTable>

The repository’s mailmap, merged in Git’s source order: .mailmap in the work tree, then mailmap.blob (HEAD:.mailmap by default in a bare repository), then mailmap.file.

§Errors

Config load failures and unreadable mailmap.file paths; a mailmap.blob that does not resolve to a blob is skipped with a diagnostic.

Source§

impl<'repo> Config<'repo>

Source

pub fn set( &self, scope: ConfigScope, key: &str, value: &str, options: &ConfigWriteOptions, ) -> Result<Option<ConfigWritePreview>>

Set key to value in the config file for scope.

Source

pub fn add_value( &self, scope: ConfigScope, key: &str, value: &str, options: &ConfigWriteOptions, ) -> Result<Option<ConfigWritePreview>>

Append value for a multi-valued key in the config file for scope.

Source

pub fn unset( &self, scope: ConfigScope, key: &str, options: &ConfigWriteOptions, ) -> Result<Option<ConfigWritePreview>>

Remove the last value for key in the config file for scope.

Source

pub fn unset_all( &self, scope: ConfigScope, key: &str, options: &ConfigWriteOptions, ) -> Result<(usize, Option<ConfigWritePreview>)>

Remove every value for key in the config file for scope.

Source

pub fn rename_section( &self, scope: ConfigScope, old_name: &str, new_name: &str, options: &ConfigWriteOptions, ) -> Result<Option<ConfigWritePreview>>

Rename a section in the config file for scope.

Source

pub fn remove_section( &self, scope: ConfigScope, section: &str, options: &ConfigWriteOptions, ) -> Result<Option<ConfigWritePreview>>

Remove an entire section from the config file for scope.

Trait Implementations§

Source§

impl<'repo> Clone for Config<'repo>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'repo> Copy for Config<'repo>

Source§

impl<'repo> Debug for Config<'repo>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'repo> !RefUnwindSafe for Config<'repo>

§

impl<'repo> !UnwindSafe for Config<'repo>

§

impl<'repo> Forget for Config<'repo>

§

impl<'repo> Freeze for Config<'repo>

§

impl<'repo> Send for Config<'repo>

§

impl<'repo> Sync for Config<'repo>

§

impl<'repo> Unpin for Config<'repo>

§

impl<'repo> UnsafeUnpin for Config<'repo>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.