Struct PathBuf 

pub struct PathBuf { /* private fields */ }

An owned, mutable Path (akin to String).

Different from [std::path::PathBuf], this type is always UTF-8 encoded.

Implementations

impl PathBuf

pub const fn new() -> Self

pub fn pop(&mut self) -> bool

pub fn push(&mut self, path: impl AsRef<Path>)

Methods from Deref<Target = Path>

pub fn as_str(&self) -> &str

pub fn as_bytes(&self) -> &[u8]

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

Produces an iterator over the [Components] of the path.

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

Returns the final component of the Path, if there is one.

pub fn join(&self, other: impl AsRef<Path>) -> PathBuf

Creates an owned PathBuf with path adjoined to self.

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

Returns the Path without its final component, if there is one.

pub fn is_absolute(&self) -> bool

Returns true if the Path is absolute, i.e., if it is independent of the current directory.

pub fn normalize(&self) -> Option<PathBuf>

Normalizes a path without performing I/O.

Trait Implementations

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

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

impl AsRef<str> for PathBuf

fn as_ref(&self) -> &str

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

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Debug for PathBuf

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

Formats the value using the given formatter.

impl Default for PathBuf

fn default() -> PathBuf

Returns the “default value” for a type.

impl Deref for PathBuf

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Path

Dereferences the value.

impl Display for PathBuf

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

Formats the value using the given formatter.

impl From<&str> for PathBuf

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for PathBuf

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T: AsRef<Path>> FromIterator<T> for PathBuf

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for PathBuf

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 PathBuf

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PathBuf

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

impl StructuralPartialEq for PathBuf