Enum Kind

pub enum Kind {
    PossiblyBare,
    WorkTree {
        linked_git_dir: Option<PathBuf>,
    },
    WorkTreeGitDir {
        work_dir: PathBuf,
    },
    Submodule {
        git_dir: PathBuf,
    },
    SubmoduleGitDir,
}

The kind of repository path.

Variants

PossiblyBare

A bare repository does not have a work tree, that is files on disk beyond the git repository itself.

Note that this is merely a guess at this point as we didn’t read the configuration yet.

Also note that due to optimizing for performance and just making an educated guess in some situations, we may consider a non-bare repository bare if it doesn’t have an index yet due to be freshly initialized. The caller has to handle this, typically by reading the configuration.

It could also be a directory which is non-bare by configuration, but is not named .git. Unusual, but it’s possible that a worktree is configured via core.worktree.

WorkTree

A git repository along with checked out files in a work tree.

Fields

linked_git_dir: Option<PathBuf>

If set, this is the git dir associated with this linked worktree. If None, the git_dir is the .git directory inside the main worktree we represent.

WorkTreeGitDir

A worktree’s git directory in the common.git directory in worktrees/<name>.

Fields

work_dir: PathBuf

Path to the worktree directory.

Submodule

The directory is a .git dir file of a submodule worktree.

Fields

git_dir: PathBuf

The git repository itself that is referenced by the .git dir file, typically in the .git/modules/**/<name> directory of the parent repository.

SubmoduleGitDir

The git directory in the .git/modules/**/<name> directory tree of the parent repository

Implementations

impl Kind

pub fn is_bare(&self) -> bool

Returns true if this is a bare repository, one without a work tree.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl Hash for Kind

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

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 Kind

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Kind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Kind

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Kind

impl StructuralPartialEq for Kind