Struct RepositoryPath 

pub struct RepositoryPath(PathBuf);

A normalized, relative, parent-free repository path.

TryFrom is the only way to build one, so every value already holds the invariant: no absolute paths, no empty segments, and no .. traversal. "." is accepted as a reference to the repository root.

Tuple Fields

0: PathBuf

Implementations

impl RepositoryPath

pub fn as_path(&self) -> &Path

Borrow the normalized relative path.

pub fn resolve(&self, root: &RepositoryRoot) -> Result<PathBuf, PathError>

Resolve this path against a repository root, rejecting symlinks in any parent or leaf component.

Missing final files are allowed so callers can safely plan their creation.

Errors

Returns an error when a parent or leaf component is a symlink, an ancestor is inaccessible, or the resolved path escapes the repository.

pub(crate) fn reject_case_collisions<'a>( paths: impl IntoIterator<Item = &'a Self>, ) -> Result<(), FilesError>

Reject a set of paths that differ only by case.

Two declared paths differing only in case collide on the case-insensitive filesystems macOS and Windows default to, even though RepositoryPath equality is byte-exact.

Errors

Returns an error naming the first two paths found that are distinct but match when lowercased.

Trait Implementations

impl Clone for RepositoryPath

fn clone(&self) -> RepositoryPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepositoryPath

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

Formats the value using the given formatter.

impl Display for RepositoryPath

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

Formats the value using the given formatter.

impl Eq for RepositoryPath

impl<'ʄ> Facet<'ʄ> for RepositoryPath

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl From<&RepositoryPath> for String

fn from(path: &RepositoryPath) -> Self

Converts to this type from the input type.

impl FromStr for RepositoryPath

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, PathError>

Parses a string s to return a value of this type.

impl Hash for RepositoryPath

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 RepositoryPath

fn cmp(&self, other: &RepositoryPath) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RepositoryPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RepositoryPath

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

impl TryFrom<&Path> for RepositoryPath

type Error = PathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for RepositoryPath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<String> for RepositoryPath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, PathError>

Performs the conversion.