Struct ProjectRootId 

pub struct ProjectRootId(/* private fields */);

Stable canonical identity for a project root.

A ProjectRootId is represented by the canonical filesystem path of an existing project root. Construction uses std::fs::canonicalize, so the stored path is absolute, has ./../trailing separators collapsed, and has symlinks resolved.

Git worktrees are first-class roots: this crate does not ask Git for a repository common-dir and does not collapse linked worktrees back to their main checkout. Because a linked worktree has its own checkout directory, the canonical worktree path is a distinct id from the canonical main-checkout path while alternate spellings of either path still converge.

Implementations

impl ProjectRootId

pub fn from_path(path: impl AsRef<Path>) -> Result<ProjectRootId, IdentityError>

Resolve an existing filesystem path into a canonical project-root id.

Non-existent paths are rejected with IdentityError::NonExistentPath instead of being logically normalized. That policy avoids silently aliasing roots whose future meaning could change when missing path components or symlinks are later created.

pub fn as_path(&self) -> &Path

Borrow the canonical path backing this identity.

pub fn into_path_buf(self) -> PathBuf

Consume the identity and return its canonical path representation.

Trait Implementations

impl AsRef<Path> for ProjectRootId

fn as_ref(&self) -> &Path

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

impl Clone for ProjectRootId

fn clone(&self) -> ProjectRootId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectRootId

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

Formats the value using the given formatter.

impl Display for ProjectRootId

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

Formats the value using the given formatter.

impl Eq for ProjectRootId

impl Hash for ProjectRootId

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 PartialEq for ProjectRootId

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

impl TryFrom<&Path> for ProjectRootId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from( value: &Path, ) -> Result<ProjectRootId, <ProjectRootId as TryFrom<&Path>>::Error>

Performs the conversion.

impl TryFrom<&str> for ProjectRootId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<ProjectRootId, <ProjectRootId as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<PathBuf> for ProjectRootId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from( value: PathBuf, ) -> Result<ProjectRootId, <ProjectRootId as TryFrom<PathBuf>>::Error>

Performs the conversion.

impl TryFrom<String> for ProjectRootId

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ProjectRootId, <ProjectRootId as TryFrom<String>>::Error>

Performs the conversion.