Struct RelPath 

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

A file system path that is guaranteed to be relative and normalized.

This type can be used to represent paths in a uniform way, regardless of whether they refer to Windows or POSIX file systems, and regardless of the host platform.

Internally, paths are stored in POSIX (‘/’-delimited) format, but they can be displayed in either POSIX or Windows format.

Relative paths are also guaranteed to be valid unicode.

Implementations

impl RelPath

pub fn empty() -> &'static Self

Creates an empty RelPath.

pub fn empty_arc() -> Arc<Self>

Creates an empty RelPath.

pub fn new<'a>(path: &'a Path, path_style: PathStyle) -> Result<Cow<'a, Self>>

Converts a path with a given style into a RelPath.

Returns an error if the path is absolute, or is not valid unicode.

This method will normalize the path by removing . components, processing .. components, and removing trailing separators. It does not allocate unless it’s necessary to reformat the path.

pub fn new_test<'a>(path: &'a str) -> Cow<'a, Self>

pub fn from_unix_str<S: AsRef<Path> + ?Sized>(path: &S) -> Result<&Self>

Converts a path that is already normalized and uses ‘/’ separators into a RelPath .

Returns an error if the path is not already in the correct format.

pub fn is_empty(&self) -> bool

pub fn components(&self) -> RelPathComponents<'_>

pub fn ancestors(&self) -> RelPathAncestors<'_>

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

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

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

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

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

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

Returns true if this path is a strict descendant of ancestor.

Unlike starts_with, this returns false when self == ancestor and false when ancestor is empty (since every path trivially starts with the empty prefix).

pub fn ends_with(&self, other: &Self) -> bool

pub fn strip_prefix<'a>( &'a self, other: &Self, ) -> Result<&'a Self, StripPrefixError>

pub fn len(&self) -> usize

pub fn last_n_components(&self, count: usize) -> Option<&Self>

pub fn join(&self, other: &Self) -> RelPathBuf

pub fn to_rel_path_buf(&self) -> RelPathBuf

pub fn into_arc(&self) -> Arc<Self>

pub fn display(&self, style: PathStyle) -> Cow<'_, str>

Convert the path into a string with the given path style.

Whenever a path is presented to the user, it should be converted to a string via this method.

pub fn as_unix_str(&self) -> &str

Get the internal unix-style representation of the path.

This should not be shown to the user.

pub fn as_std_path(&self) -> &Path

Interprets the path as a std::path::Path, suitable for file system calls.

This is guaranteed to be a valid path regardless of the host platform, because the / is accepted as a path separator on windows.

This should not be shown to the user.

pub fn absolutize(&self, base: impl AsRef<AbsPath>) -> AbsPathBuf

Resolves this relative path against an absolute base path.

Trait Implementations

impl AsRef<Path> for RelPath

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RelPath> for RelPathBuf

fn as_ref(&self) -> &RelPath

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RelPath> for RelPath

fn as_ref(&self) -> &RelPath

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RelPath> for RelPathBuf

fn borrow(&self) -> &RelPath

Immutably borrows from an owned value.

impl Debug for RelPath

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

Formats the value using the given formatter.

impl Display for RelPath

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

Formats the value using the given formatter.

impl Eq for RelPath

impl<'a> From<&'a RelPath> for Cow<'a, RelPath>

fn from(value: &'a RelPath) -> Self

Converts to this type from the input type.

impl From<&RelPath> for Arc<RelPath>

fn from(rel_path: &RelPath) -> Self

Converts to this type from the input type.

impl Hash for RelPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl Ord for RelPath

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

This method returns an Ordering between self and other.

impl PartialEq for RelPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<RelPath> for RelPathBuf

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<RelPathBuf> for RelPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for RelPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RelPath

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

impl ToOwned for RelPath

type Owned = RelPathBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a RelPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self>

Performs the conversion.