Struct VPath 

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

A normalized, workspace-relative virtual path.

Implementations

impl VPath

pub fn root() -> Self

Return the canonical virtual workspace root.

pub fn parse(input: &str) -> Result<Self, VPathError>

Parse and normalize a portable virtual path.

Both slash styles are treated as separators so a path accepted on one host cannot become an escape on another. Parent components may simplify a path but may never escape the virtual root.

Errors

Returns VPathError when the input is empty, absolute, contains a NUL byte or platform prefix, or would escape the virtual root during normalization.

pub fn as_str(&self) -> &str

Return the canonical slash-separated representation.

pub fn is_root(&self) -> bool

Return whether this path denotes the virtual workspace root.

pub fn parent(&self) -> Option<Self>

Return the normalized parent, or None for the virtual root.

pub fn file_name(&self) -> Option<&str>

Return the final path component, or None for the virtual root.

pub fn join(&self, child: &str) -> Result<Self, VPathError>

Join and normalize a relative child path.

Errors

Returns VPathError if child is invalid or the combined path escapes the virtual root.

pub fn is_within(&self, ancestor: &Self) -> bool

Return whether this path is equal to or below ancestor.

pub fn relative_to<'a>(&'a self, ancestor: &Self) -> Option<&'a str>

Return the normalized relative suffix below ancestor.

pub fn rebase(&self, from: &Self, to: &Self) -> Result<Option<Self>, VPathError>

Rebase this path from one virtual subtree to another.

Errors

Returns VPathError if the rebased path would be invalid.

Trait Implementations

impl Clone for VPath

fn clone(&self) -> VPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VPath

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

Formats the value using the given formatter.

impl Display for VPath

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

Formats the value using the given formatter.

impl Eq for VPath

impl Hash for VPath

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 VPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VPath

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

impl TryFrom<&str> for VPath

type Error = VPathError

The type returned in the event of a conversion error.

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

Performs the conversion.