Enum git_repository::discover::repository::Kind

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

The kind of repository path.

Variants

Bare

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.

WorkTree

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.

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

WorkTreeGitDir

Fields

work_dir: PathBuf

Path to the worktree directory.

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

Submodule

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.

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

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<(), Error>

Formats the value using the given formatter.

impl From<Kind> for Kind

fn from(v: Kind) -> Self

Converts to this type from the input type.

impl Hash for Kind

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 Kind

fn cmp(&self, other: &Kind) -> 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<Kind> for Kind

fn eq(&self, other: &Kind) -> 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<Kind> 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

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 Eq for Kind

impl StructuralEq for Kind

impl StructuralPartialEq for Kind