Skip to main content

ConfigSnapshot

Struct ConfigSnapshot 

Source
pub struct ConfigSnapshot { /* private fields */ }
Expand description

What: The parsed listing of one Git configuration read. Why: It is read once per commit with the caller’s global options, and reused by the consumers that would otherwise each start git config.

In TS you’d write (pseudocode):

type ConfigSnapshot = { entries: ConfigEntry[]; readWithoutGlobalOptions: boolean };

Implementations§

Source§

impl ConfigSnapshot

Source

pub fn parse(listing: &[u8], without_global_options: bool) -> Option<Self>

What: Parse the bytes of git config --list -z --show-scope. Why: The listing is scope NUL key [LF value] NUL repeated; a listing in any other shape is refused whole, so a half-understood configuration is never used.

In TS you’d write (pseudocode):

parseConfigList(bytes, { withoutGlobalOptions });
Source

pub fn entries(&self) -> &[ConfigEntry]

What: The entries in listing order. Why: Consumers that scan for a family of keys (hook definitions) read them directly.

In TS you’d write (pseudocode):

snapshot.entries
Source

pub fn without_global_options(&self) -> bool

What: Whether the read carried no global options, so a consumer that runs Git without them may reuse it. Why: A -c, -C or --git-dir in front of the read changes what Git lists, and a consumer that ignores the caller’s options must not see their effect.

In TS you’d write (pseudocode):

snapshot.withoutGlobalOptions
Source

pub fn path_value(&self, key: &str) -> Lookup<String>

What: git config --type=path --get <key> for values Git returns unchanged. Why: core.hooksPath is read this way.

In TS you’d write (pseudocode):

snapshot.pathValue('core.hookspath');
Source

pub fn bool_value(&self, key: &str) -> Lookup<bool>

What: git config --type=bool --get <key>. Why: The hook switches are read this way.

In TS you’d write (pseudocode):

snapshot.boolValue('hook.pre-commit.enabled');
Source

pub fn maintenance_records(&self) -> Option<BTreeMap<String, String>>

What: The maintenance keys as git config --type=bool-or-int --null --get-regexp prints them: each set key with the text of its last value. Why: The maintenance decision parses that listing; None when any maintenance entry is not modelled.

In TS you’d write (pseudocode):

snapshot.maintenanceRecords();
Source

pub fn proves_files_ref_storage(&self) -> bool

What: Whether the ref storage is proven to be the files backend. Why: git rev-parse --show-ref-format prints reftable only when extensions.refStorage is set, so a listing without that key, read without global options, proves files; any listing that names the key (in any scope, from any file) is left to Git, which also applies the repository-format rules.

In TS you’d write (pseudocode):

snapshot.withoutGlobalOptions && !snapshot.entries.some((entry) => entry.key === 'extensions.refstorage');

Trait Implementations§

Source§

impl Clone for ConfigSnapshot

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 ConfigSnapshot

Source§

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

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

impl Eq for ConfigSnapshot

Source§

impl PartialEq for ConfigSnapshot

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 ConfigSnapshot

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more