Struct RelPathBuf 

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

An owned representation of a file system path that is guaranteed to be relative and normalized.

This type is to RelPath as std::path::PathBuf is to std::path::Path

Implementations

impl RelPathBuf

pub fn new() -> Self

pub fn pop(&mut self) -> bool

pub fn push(&mut self, path: &RelPath)

pub fn push_component(&mut self, component: &str) -> Result<()>

pub fn as_rel_path(&self) -> &RelPath

pub fn set_extension(&mut self, extension: &str) -> bool

Methods from Deref<Target = RelPath>

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 RelPathBuf

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 Borrow<RelPath> for RelPathBuf

fn borrow(&self) -> &RelPath

Immutably borrows from an owned value.

impl Clone for RelPathBuf

fn clone(&self) -> RelPathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelPathBuf

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

Formats the value using the given formatter.

impl Deref for RelPathBuf

type Target = RelPath

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for RelPathBuf

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

Formats the value using the given formatter.

impl Eq for RelPathBuf

impl From<RelPathBuf> for Arc<RelPath>

fn from(value: RelPathBuf) -> Self

Converts to this type from the input type.

impl Hash for RelPathBuf

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 RelPathBuf

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

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

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 RelPathBuf

impl TryFrom<&str> for RelPathBuf

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.