Struct Path 

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

A borrowed native path with lexical operations only.

Filesystem-query methods are deliberately absent. Use this crate’s operation modules to inspect or mutate the host filesystem.

Tuple Fields

0: Path

Implementations

impl Path

pub fn new<S>(path: &S) -> &Self

where S: AsRef<OsStr> + ?Sized,

Borrow a native path without allocating.

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 Path

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for Path

fn as_ref(&self) -> &NativePath

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

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

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 Debug for Path

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

Formats the value using the given formatter.

impl From<&Path> for PathBuf

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl Hash for Path

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl Ord for Path

fn cmp(&self, other: &Path) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for Path

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

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

type From = Path

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl Eq for Path

impl StructuralPartialEq for Path