Struct git_repository::worktree::fs::Capabilities

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

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

Fields

precompose_unicode: bool

If true, the filesystem will store paths as decomposed unicode, i.e. ä becomes "a\u{308}", which means that we have to turn these forms back from decomposed to precomposed unicode before storing it in the index or generally using it. This also applies to input received from the command-line, so callers may have to be aware of this and perform conversions accordingly. If false, no conversions will be performed.

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 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

impl Capabilities

pub fn probe(git_dir: impl AsRef<Path>) -> Capabilities

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

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

Available on Unix and non-macOS only.

fn default() -> Capabilities

Returns the “default value” for a type.

impl Hash for Capabilities

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Capabilities

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Capabilities> for Capabilities

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Capabilities> for Capabilities

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Capabilities

impl Eq for Capabilities

impl StructuralEq for Capabilities

impl StructuralPartialEq for Capabilities