Struct Path 

pub struct Path<'a>(/* private fields */);

A borrowed path in a target’s syntax.

Implementations

impl<'a> Path<'a>

pub fn new(path: &'a (impl AsRef<str> + ?Sized), kind: Kind) -> Self

Creates a path with the given syntax.

pub fn unix(path: &'a (impl AsRef<str> + ?Sized)) -> Self

Creates a path with Unix syntax.

pub fn windows(path: &'a (impl AsRef<str> + ?Sized)) -> Self

Creates a path with Windows syntax.

pub fn kind(&self) -> Kind

Returns this path’s syntax.

pub fn as_str(&self) -> &'a str

Returns the path text.

pub fn to_path_buf(&self) -> PathBuf

Converts this path into an owned path.

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

Converts this path into the given syntax.

Returns the path unchanged when it already uses kind.

Errors

Only relative, unrooted paths carrying no alternate data stream specifier can be converted between syntaxes.

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<'a>>

Returns the path with base removed from its front.

Errors

Fails if the path does not begin with base.

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

Returns the path without its final component.

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

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

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

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

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

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

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

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

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

Returns the alternate data stream specified by the final component.

Always None for a Unix path.

Errors

Fails if the final component carries a suffix that does not follow the name:stream[:$TYPE] grammar.

pub fn with_stream(&self, spec: Option<StreamSpec<'_>>) -> PathBuf

Returns this path with its alternate data stream specifier replaced.

Has no effect on a Unix path.

pub fn without_stream(&self) -> PathBuf

Returns this path with any alternate data stream specifier removed.

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

Returns an iterator over the path’s components.

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

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

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

Returns this path with path appended.

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

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

pub fn with_file_name_raw(&self, file_name: impl AsRef<str>) -> PathBuf

Returns this path with its final component replaced verbatim, dropping any alternate data stream suffix along with the name it was attached to.

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

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

pub fn normalize(&self) -> PathBuf

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

This is a purely textual operation: no symlink is resolved and the target is never consulted.

Trait Implementations

impl AsRef<str> for Path<'_>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Path<'a>

fn clone(&self) -> Path<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Path<'a>

impl<'a> Debug for Path<'a>

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

Formats the value using the given formatter.

impl Display for Path<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for Path<'a>

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

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

fn cmp(&self, other: &Path<'a>) -> 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<'a> PartialEq for Path<'a>

fn eq(&self, other: &Path<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> PartialOrd for Path<'a>

fn partial_cmp(&self, other: &Path<'a>) -> 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<'a> StructuralPartialEq for Path<'a>