Enum git_repository::Path

pub enum Path {
    WorkTree(PathBuf),
    Repository(PathBuf),
}

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

Variants

WorkTree(PathBuf)

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

Repository(PathBuf)

The git repository itself

Implementations

impl Path

pub fn from_dot_git_dir(dir: impl Into<PathBuf>, kind: Kind) -> Self

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.

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

Formats the value using the given formatter.

impl Hash for Path

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, 

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> 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: &Path) -> bool

This method tests for !=.

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 TryFrom<Path> for ThreadSafeRepository

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Path) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path