Struct RelPath 

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

A declared path that is relative to a section root and cannot leave it.

The value is normalized the way Python’s Path(value) does it: empty and . components are dropped, so "a//b/./c/" and "a/b/c" are the same path, and both "" and "." are the root. Absolute paths and any .. component are rejected: a level declares paths, not locations, and a .. could let it read or write outside the workspace.

Implementations

impl RelPath

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

Validate and normalize a declared path.

pub fn root() -> Self

The root itself (no components).

pub fn is_root(&self) -> bool

True for "" and ".": the section root.

pub fn as_str(&self) -> &str

The normalized text: components joined by /, and "" for the root.

pub fn components(&self) -> impl DoubleEndedIterator<Item = &str>

The path components, outermost first.

pub fn depth(&self) -> usize

Number of components; the root has depth 0.

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

The last component, or None for the root.

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

The path without its last component, or None for the root.

pub fn starts_with(&self, other: &RelPath) -> bool

True when self is other or lies below it (component-wise, so maze2 is not inside maze). Every path is inside the root.

pub fn under(&self, root: &Path) -> PathBuf

Place this path under root. The root path maps to root itself, without the trailing slash that Path::join("") would add.

Trait Implementations

impl Clone for RelPath

fn clone(&self) -> RelPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelPath

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

Formats the value using the given formatter.

impl Default for RelPath

fn default() -> RelPath

Returns the “default value” for a type.

impl Display for RelPath

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

Formats the value using the given formatter.

impl Eq for RelPath

impl FromStr for RelPath

type Err = PathError

The associated error which can be returned from parsing.

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

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

impl Hash for RelPath

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 RelPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RelPath

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