Struct ProjectRoot 

pub struct ProjectRoot { /* private fields */ }

A normalized immutable project boundary.

Construction and resolution are lexical: neither operation requires the path to exist. Every path returned by this type is absolute, normalized, and confined.

Implementations

impl ProjectRoot

pub fn new(path: impl AsRef<Path>) -> Result<Self, PathError>

Creates a project boundary from an absolute path without touching the file system.

pub fn path(&self) -> &Path

Returns the normalized absolute root.

pub fn resolve(&self, path: impl AsRef<Path>) -> Result<PathBuf, PathError>

Resolves a root-relative or already-absolute path and rejects root escapes.

pub fn resolve_from( &self, directory: impl AsRef<Path>, path: impl AsRef<Path>, ) -> Result<PathBuf, PathError>

Resolves a path relative to a confined absolute directory.

pub fn confine(&self, path: impl AsRef<Path>) -> Result<PathBuf, PathError>

Normalizes an absolute path and verifies that it belongs to this project.

Trait Implementations

impl Clone for ProjectRoot

fn clone(&self) -> ProjectRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectRoot

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

Formats the value using the given formatter.

impl Eq for ProjectRoot

impl Hash for ProjectRoot

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 ProjectRoot

fn eq(&self, other: &ProjectRoot) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProjectRoot