Struct ProjectPath 

pub struct ProjectPath(String);

A canonical, project-relative resource path used as a file dependency’s identity.

The stored string is the identity, in canonical form:

• backslashes folded to / (so a\b and a/b agree across platforms),
• . and empty segments dropped, .. resolved lexically,
• each segment NFC-normalized.

So ./a.mos, a.mos, and dir\..\dir/a.mos all yield the same ProjectPath, which is exactly what makes a file DependencyId deterministic for the same logical input (design note §3.1).

Normalization is lexical only: it never touches the filesystem, so it cannot turn a relative path absolute or leak machine layout into the identity. Absolute filesystem paths are valid inputs at outer boundaries, but they must be made project-relative before becoming a ProjectPath.

Examples

use mos_cache::ProjectPath;

assert_eq!(
    ProjectPath::new("./ch/../ch/intro.mos").map(|path| path.as_str().to_owned()),
    Ok("ch/intro.mos".to_owned())
);
assert_eq!(
    ProjectPath::new(r"figures\logo.png").map(|path| path.as_str().to_owned()),
    Ok("figures/logo.png".to_owned())
);

Tuple Fields

0: String

Implementations

impl ProjectPath

pub fn new(path: impl AsRef<str>) -> Result<Self, ProjectPathError>

Canonicalize a project-relative path into a ProjectPath. Absolute paths must be relativized against the project root before calling this.

Errors

Returns ProjectPathError when path is empty, absolute, or escapes above the project root with ...

Examples

use mos_cache::ProjectPath;

// Decomposed "é" (e + combining acute) folds to the composed form.
assert_eq!(ProjectPath::new("e\u{0301}.bib"), ProjectPath::new("\u{00e9}.bib"));

pub fn as_str(&self) -> &str

The canonical path string.

Examples

use mos_cache::ProjectPath;

assert_eq!(
    ProjectPath::new("a//b/").map(|path| path.as_str().to_owned()),
    Ok("a/b".to_owned())
);

Trait Implementations

impl Clone for ProjectPath

fn clone(&self) -> ProjectPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectPath

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

Formats the value using the given formatter.

impl Display for ProjectPath

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

Formats the value using the given formatter.

impl Hash for ProjectPath

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 Ord for ProjectPath

fn cmp(&self, other: &ProjectPath) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProjectPath

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

fn partial_cmp(&self, other: &ProjectPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ProjectPath

impl StructuralPartialEq for ProjectPath