Struct PathBuf 

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

Owned path type.

Paths are mostly arbitrary sequences of bytes, with two restrictions:

• The path cannot contain any null bytes.
• Each component of the path must be no longer than 255 bytes.

Implementations

impl PathBuf

pub fn new<P>(p: &P) -> Self

where P: AsRef<[u8]> + ?Sized,

Create a new PathBuf.

This panics if the input is invalid, use Path::try_from if error handling is desired.

Panics

Panics if the path contains any null bytes or if a component of the path is longer than 255 bytes.

pub const fn empty() -> Self

Create empty PathBuf.

pub fn as_path(&self) -> Path<'_>

Borrow as a Path.

pub fn is_absolute(&self) -> bool

Get whether the path is absolute (starts with /).

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

Get an object that implements Display to allow conveniently printing paths that may or may not be valid UTF-8. Non-UTF-8 characters will be replaced with ‘�’.

pub fn push(&mut self, path: impl AsRef<[u8]>)

Append to the path.

This will add a separator if needed. Note that if the argument is an absolute path, self will be replaced with that path.

Panics

Panics if the argument is not a valid path, or if memory cannot be allocated for the resulting path.

pub fn join(&self, path: impl AsRef<[u8]>) -> Self

Create a new PathBuf joining self with path.

This will add a separator if needed. Note that if the argument is an absolute path, the returned value will be equal to path.

Panics

Panics if the argument is not a valid path.

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

Get an iterator over each Component in the path.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Convert to a &str if the path is valid UTF-8.

Trait Implementations

impl AsRef<[u8]> for PathBuf

fn as_ref(&self) -> &[u8]

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

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<'a> From<Path<'a>> for PathBuf

fn from(p: Path<'a>) -> Self

Converts to this type from the input type.

impl From<PathBuf> for PathBuf

Available on crate feature std and Unix only.

fn from(p: PathBuf) -> Self

Converts to this type from the input 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<T> PartialEq<T> for PathBuf

where T: AsRef<[u8]>,

fn eq(&self, other: &T) -> 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 TryFrom<&[u8]> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(s: &[u8]) -> Result<Self, PathError>

Performs the conversion.

impl<const N: usize> TryFrom<&[u8; N]> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(a: &[u8; N]) -> Result<Self, PathError>

Performs the conversion.

impl<'a> TryFrom<&'a PathBuf> for Path<'a>

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(p: &'a PathBuf) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<&String> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<&str> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<OsString> for PathBuf

Available on crate feature std and Unix only.

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(p: OsString) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<PathBuf> for PathBuf

Available on crate feature std only.

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(p: PathBuf) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<String> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, PathError>

Performs the conversion.

impl TryFrom<Vec<u8>> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(s: Vec<u8>) -> Result<Self, PathError>

Performs the conversion.

impl Eq for PathBuf