Struct PathBuf 

#[repr(transparent)]
pub struct PathBuf(PathBuf);

An owned native path with lexical operations only.

Tuple Fields

0: PathBuf

Implementations

impl PathBuf

pub fn new() -> Self

Create an empty path.

pub fn as_path(&self) -> &Path

Borrow this owned path.

pub fn push<S>(&mut self, path: S)

where S: AsRef<NativePath>,

Append a lexical path.

pub fn pop(&mut self) -> bool

Remove the final component.

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

where S: AsRef<OsStr>,

Replace the final extension.

pub fn into_os_string(self) -> OsString

Consume this path as an operating-system string.

Methods from Deref<Target = Path>

pub fn as_os_str(&self) -> &OsStr

Return the underlying operating-system string.

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

Return this path as UTF-8 when every byte is valid UTF-8.

pub fn display(&self) -> Display<'_>

Return a display adapter that replaces invalid UTF-8 lossily.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Return this path as a potentially lossy string.

pub fn to_path_buf(&self) -> PathBuf

Allocate an owned copy.

pub fn join<S>(&self, path: S) -> PathBuf

where S: AsRef<NativePath>,

Join a lexical path segment.

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

Return the parent path.

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

Iterate over this path and each lexical parent.

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

Return the final component.

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

Return the final component without its last extension.

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

Return the final extension.

pub fn with_file_name<S>(&self, file_name: S) -> PathBuf

where S: AsRef<OsStr>,

Return a path with a different final component.

pub fn with_extension<S>(&self, extension: S) -> PathBuf

where S: AsRef<OsStr>,

Return a path with a different extension.

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

Iterate over normalized lexical components.

pub fn starts_with<S>(&self, base: S) -> bool

where S: AsRef<NativePath>,

Report whether this path begins with base on component boundaries.

pub fn strip_prefix<S>(&self, base: S) -> Result<&Self, StripPrefixError>

where S: AsRef<NativePath>,

Remove a component-aligned prefix.

Errors

Returns an error when base is not a lexical prefix of this path.

pub fn is_absolute(&self) -> bool

Report whether the path is absolute for the current platform.

pub fn is_empty(&self) -> bool

Report whether the path has no components.

Trait Implementations

impl AsRef<OsStr> for PathBuf

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &NativePath

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

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

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 Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for PathBuf

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PathBuf

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

Formats the value using the given formatter.

impl From<&OsStr> for PathBuf

fn from(path: &OsStr) -> Self

Converts to this type from the input type.

impl From<&Path> for PathBuf

fn from(path: &NativePath) -> Self

Converts to this type from the input type.

impl From<&Path> for PathBuf

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for PathBuf

fn from(path: &str) -> Self

Converts to this type from the input type.

impl From<OsString> for PathBuf

fn from(path: OsString) -> Self

Converts to this type from the input type.

impl From<PathBuf> for OsString

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl From<PathBuf> for PathBuf

fn from(path: NativePathBuf) -> Self

Converts to this type from the input type.

impl From<String> for PathBuf

fn from(path: String) -> Self

Converts to this type from the input type.

impl FromStr for PathBuf

type Err = Infallible

The associated error which can be returned from parsing.

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

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

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 Serialize for PathBuf

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PathBuf

impl StructuralPartialEq for PathBuf