Struct PathBuf 

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

An owned path in a target’s syntax.

Implementations

impl PathBuf

pub fn new(path: impl AsRef<str>, kind: Kind) -> Self

Creates a path with the given syntax.

pub fn from_unix(path: impl AsRef<str>) -> Self

Creates a path with Unix syntax.

pub fn from_windows(path: impl AsRef<str>) -> Self

Creates a path with Windows syntax.

pub fn empty(kind: Kind) -> Self

Creates an empty path with the given syntax.

pub fn from_native(path: PathBuf) -> Result<Self>

Creates a path from a native host path.

Errors

Fails if the path is not valid UTF-8.

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

Borrows this path.

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

Appends path.

pub fn pop(&mut self) -> bool

Removes the final component, returning whether one was removed.

pub fn set_file_name(&mut self, file_name: impl AsRef<str>)

Replaces the final component, keeping any alternate data stream suffix.

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

Replaces the extension of the final component, keeping any alternate data stream suffix, and returns whether the path had a final component to modify.

pub fn set_stream(&mut self, spec: Option<StreamSpec<'_>>)

Replaces the alternate data stream specifier of the final component.

Has no effect on a Unix path.

impl PathBuf

Methods shared with Path, forwarded for convenience.

pub fn kind(&self) -> Kind

Returns this path’s syntax.

pub fn as_str(&self) -> &str

Returns the path text.

pub fn to_native(&self) -> Result<PathBuf>

Converts this path into a native host path.

Errors

Fails if this path’s syntax is not the host’s syntax.

pub fn to_kind(&self, kind: Kind) -> Result<Self>

Converts this path into the given syntax.

Errors

See Path::to_kind.

pub fn is_absolute(&self) -> bool

Returns whether the path is absolute.

pub fn is_relative(&self) -> bool

Returns whether the path is relative.

pub fn has_root(&self) -> bool

Returns whether the path has a root component.

pub fn starts_with(&self, base: impl AsRef<str>) -> bool

Returns whether the path begins with base.

pub fn ends_with(&self, child: impl AsRef<str>) -> bool

Returns whether the path ends with child.

pub fn strip_prefix(&self, base: impl AsRef<str>) -> Result<Path<'_>>

Returns the path with base removed from its front.

Errors

Fails if the path does not begin with base.

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

Returns the path without its final component.

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

Returns the final component, excluding any alternate data stream suffix.

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

Returns the final component exactly as it is spelled, including any alternate data stream suffix.

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

Returns the final component without its extension or its alternate data stream suffix.

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

Returns the extension of the final component, ignoring any alternate data stream suffix.

pub fn stream(&self) -> Result<Option<StreamSpec<'_>>>

Returns the alternate data stream specified by the final component.

Errors

See Path::stream.

pub fn without_stream(&self) -> Self

Returns this path with any alternate data stream specifier removed.

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

Returns an iterator over the path’s components.

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

Returns this path with path appended.

pub fn with_file_name(&self, file_name: impl AsRef<str>) -> Self

Returns this path with its final component replaced, keeping any alternate data stream suffix.

pub fn with_extension(&self, extension: impl AsRef<str>) -> Self

Returns this path with the extension of its final component replaced, keeping any alternate data stream suffix.

pub fn normalize(&self) -> Self

Returns this path with . components removed and .. components resolved lexically.

pub fn windows_prefix(&self) -> Option<WindowsPrefix<'_>>

Returns the Windows prefix, if this is a prefixed Windows path.

Trait Implementations

impl AsRef<str> for PathBuf

fn as_ref(&self) -> &str

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<'de> Deserialize<'de> for PathBuf

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

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

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

fn from(path: &'a PathBuf) -> Self

Converts to this type from the input type.

impl<'a> From<Path<'a>> for PathBuf

fn from(path: Path<'a>) -> 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.

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 PathBuf

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

Equality operator ==.

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

Inequality operator !=.

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: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathBuf

impl TryFrom<PathBuf> for PathBuf

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self>

Performs the conversion.

impl TryFrom<PathBuf> for PathBuf

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self>

Performs the conversion.