Struct CanonicalProjectRoot 

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

One canonical native filesystem root.

Equality is native-path equality after filesystem canonicalization. The value is the authority for routing and persistence; its display projection is only for terminal diagnostics and compatibility metadata.

Implementations

impl CanonicalProjectRoot

pub fn from_path(path: &Path) -> CoreResult<Self>

Canonicalize an existing absolute directory into a native identity.

Errors

Returns an error when the path is relative, missing, or cannot be canonicalized by the host filesystem.

pub fn from_persisted_path(path: PathBuf) -> CoreResult<Self>

Construct an identity from a persisted native path whose filesystem object may no longer exist.

This is the migration and recovery entry point for historical worktree identities. It uses the same identity type and lexical validation as Self::decode, but deliberately does not require a live directory. Active filesystem admission must continue to use Self::from_path.

Errors

Returns an error when the path is relative, contains an interior NUL, or does not satisfy the native canonical lexical contract.

pub fn as_path(&self) -> &Path

Return the canonical native path.

pub fn into_path(self) -> PathBuf

Consume the identity and return its canonical native path.

pub fn display_string(&self) -> CoreResult<String>

Return the UTF-8 terminal/compatibility display projection.

A native root containing bytes that are not UTF-8 has no lossless text display. Callers carrying identity or compatibility state must retain this typed refusal instead of turning the path into replacement text.

Errors

Returns CoreError::NonUtf8Path when the native path has no lossless UTF-8 display projection.

pub fn display_string_lossy(&self) -> String

Return an explicitly lossy rendering for terminal-only diagnostics.

This method must not be used for identity comparison, persistence, compatibility keys, or structured adapter results.

pub fn encode(&self) -> CoreResult<Vec<u8>>

Encode the native path without lossy text conversion.

Errors

Returns an error when the host cannot encode its native path format.

pub fn decode(encoded: &[u8]) -> CoreResult<Self>

Decode one versioned native path codec value.

Errors

Returns an error when the version, platform, bytes, or decoded path is invalid.

Trait Implementations

impl Clone for CanonicalProjectRoot

fn clone(&self) -> CanonicalProjectRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalProjectRoot

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

Formats the value using the given formatter.

impl Display for CanonicalProjectRoot

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

Formats the value using the given formatter.

impl Eq for CanonicalProjectRoot

impl Hash for CanonicalProjectRoot

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

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