gix_fs

Struct Capabilities

source
pub struct Capabilities {
    pub precompose_unicode: bool,
    pub ignore_case: bool,
    pub executable_bit: bool,
    pub symlink: bool,
}
Expand description

Common knowledge about the worktree that is needed across most interactions with the work tree

Fields§

§precompose_unicode: bool

If true, the filesystem will consider the precomposed umlaut ä similar to its decomposed form "a\u{308}" and consider them the same. If false, the filesystem will only see bytes which means that the above example could live side-by-side.

Even though a filesystem that treats both forms the same will still reproduce the exact same byte sequence during traversal for instance, this might also mean that we see paths in their decomposed form (this happens when creating directory ä in MacOS Finder for example).

If Git would store such decomposed paths in the repository, which only sees bytes, on linux this might mean the path will look strange at best, which is why it prefers to store precomposed unicode on systems where it matters, like MacOS and Windows.

For best compatibility, and with this value being true, we will turn decomposed paths and input like command-line arguments into their precomposed forms, so no decomposed byte sequences should end up in storage.

§ignore_case: bool

If true, the filesystem ignores the case of input, which makes A the same file as a. This is also called case-folding.

§executable_bit: bool

If true, we assume the executable bit is honored as part of the files mode. If false, we assume the file system ignores the executable bit, hence it will be reported as ‘off’ even though we just tried to set it to be on.

§symlink: bool

If true, the file system supports symbolic links and we should try to create them. Otherwise symbolic links will be checked out as files which contain the link as text.

Implementations§

source§

impl Capabilities

source

pub fn probe(git_dir: &Path) -> Self

try to determine all values in this context by probing them in the given git_dir, which should be on the file system the git repository is located on. git_dir is a typical git repository, expected to be populated with the typical files like config.

All errors are ignored and interpreted on top of the default for the platform the binary is compiled for.

Trait Implementations§

source§

impl Clone for Capabilities

source§

fn clone(&self) -> Capabilities

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Capabilities

source§

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

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

impl Default for Capabilities

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Hash for Capabilities

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Capabilities

source§

fn cmp(&self, other: &Capabilities) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Capabilities

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Capabilities

source§

fn partial_cmp(&self, other: &Capabilities) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for Capabilities

source§

impl Eq for Capabilities

source§

impl StructuralPartialEq for Capabilities

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.