Skip to main content

ConfigLocation

Enum ConfigLocation 

Source
pub enum ConfigLocation {
    Local,
    Global,
    System,
    Worktree,
    File(PathBuf),
}
Expand description

Which config file(s) to read or write.

Variants§

§

Local

Repository .git/config (or commondir/config for linked worktrees).

§

Global

Per-user global config (XDG + ~/.gitconfig, or GIT_CONFIG_GLOBAL).

§

System

System-wide /etc/gitconfig (or platform equivalent).

§

Worktree

Per-worktree config.worktree (when enabled).

§

File(PathBuf)

A single file from -f / --file.

Implementations§

Source§

impl ConfigLocation

Source

pub fn file_scope(&self) -> ConfigScope

Scope stored in parsed entries from this location’s on-disk file.

Source

pub fn write_path( &self, env: &Environment, git_dir: Option<&Path>, ) -> Result<PathBuf>

Path to create or update when writing a value at this location.

Global writes follow Git’s writer preference: an existing ~/.gitconfig, then an existing XDG git/config, otherwise the conventional ~/.gitconfig.

§Errors

Returns Error::Config when the location needs a repository but none was given.

Source

pub fn load_single( &self, env: &Environment, git_dir: Option<&Path>, ) -> Result<ConfigSet>

Load configuration from this location only (no full cascade).

[include] / [includeIf] directives are expanded. Command-line overrides are not included except for the full-repository ConfigSet::load path used by the CLI default read mode.

Trait Implementations§

Source§

impl Clone for ConfigLocation

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 Debug for ConfigLocation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ConfigLocation

Source§

impl PartialEq for ConfigLocation

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ConfigLocation

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.