Skip to main content

ConfigHandle

Struct ConfigHandle 

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

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

Implementations§

Source§

impl<'repo> ConfigHandle<'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 get(&self, key: &str) -> Result<Option<String>>

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

§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_handle().get("core.repositoryformatversion");
Source

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

Set a key in the repository-local config file and reload the in-memory snapshot.

For linked worktrees this writes commondir/config when the per-worktree git directory has no config file, matching Git’s --local target.

§Errors

Propagates config parse, validation, and I/O errors.

Source

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

Remove key from the repository-local config file and reload the snapshot.

§Errors

Propagates config parse, validation, and I/O errors.

Source

pub fn remove_local_section(&self, section: &str) -> Result<()>

Remove an entire section from the repository-local config file.

Section names use dotted form (for example branch.topic or branch.feature/x).

§Errors

Propagates config parse, validation, and I/O errors.

Source

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

Shared merged config snapshot (same as Repository::config).

Trait Implementations§

Source§

impl<'repo> Clone for ConfigHandle<'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 ConfigHandle<'repo>

Source§

impl<'repo> Debug for ConfigHandle<'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 ConfigHandle<'repo>

§

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

§

impl<'repo> Freeze for ConfigHandle<'repo>

§

impl<'repo> Send for ConfigHandle<'repo>

§

impl<'repo> Sync for ConfigHandle<'repo>

§

impl<'repo> Unpin for ConfigHandle<'repo>

§

impl<'repo> UnsafeUnpin for ConfigHandle<'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.