Enum git_repository::discover::repository::Path

pub enum Path {
    LinkedWorkTree {
        work_dir: PathBuf,
        git_dir: PathBuf,
    },
    WorkTree(PathBuf),
    Repository(PathBuf),
}

A repository path which either points to a work tree or the .git repository itself.

Variants

LinkedWorkTree

Fields

work_dir: PathBuf

The base of the work tree.

git_dir: PathBuf

The worktree-private git dir, located within the main git directory which holds most of the information.

The currently checked out linked worktree along with its connected and existing git directory, or the worktree checkout of a submodule.

WorkTree(PathBuf)

The currently checked out or nascent work tree of a git repository

Repository(PathBuf)

The git repository itself, typically bare and without known worktree.

Note that it might still have linked work-trees which can be accessed later, weather bare or not, or it might be a submodule git directory in the .git/modules/**/<name> directory of the parent repository.

Implementations

impl Path

pub fn from_dot_git_dir(
    dir: impl Into<PathBuf>,
    kind: Kind,
    current_dir: impl AsRef<Path>
) -> Option<Path>

Instantiate a new path from dir which is expected to be the .git directory, with kind indicating whether it’s a bare repository or not, with current_dir being used to absolutize relative paths as needed.

None is returned if dir could not be resolved due to being relative and trying to reach outside of the filesystem root.

pub fn kind(&self) -> Kind

Returns the kind of this repository path.

pub fn into_repository_and_work_tree_directories(
    self
) -> (PathBuf, Option<PathBuf>)

Consume and split this path into the location of the .git directory as well as an optional path to the work tree.

Trait Implementations

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Hash for Path

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 Path

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

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

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

impl StructuralEq for Path

impl StructuralPartialEq for Path