Struct Path 

pub struct Path<State: PathState> { /* private fields */ }

Available on Linux only.

Implementations

impl Path<Abs>

pub fn root() -> &'static Path<Abs>

pub fn read_all_links(&self) -> Result<OwnedPath<Abs>, RawOsError>

pub fn normalize_lexically(&self) -> OwnedPath<Abs>

pub fn make_relative<P: AsRef<Path<Abs>>>(&self, from: P) -> OwnedPath<Rel>

pub fn metadata(&self) -> Result<Metadata, PathOrMetadataError>

pub fn metadata_no_follow(&self) -> Result<Metadata, PathOrMetadataError>

impl<S: PathState> Path<S>

pub fn new<'a, O: AsRef<OsStr> + ?Sized>(value: &'a O) -> Cow<'a, Path<S>>

pub fn from_checked<O: AsRef<OsStr> + ?Sized>(value: &O) -> Option<&Path<S>>

pub unsafe fn from_unchecked<O: AsRef<OsStr> + ?Sized>(value: &O) -> &Self

pub unsafe fn from_unchecked_mut<O: AsMut<OsStr> + ?Sized>( value: &mut O, ) -> &mut Self

pub const fn display<'a>(&'a self) -> DisplayPath<'a, S>

pub fn len(&self) -> NonZero<usize>

pub const fn as_os_str(&self) -> &OsStr

pub fn as_os_str_no_lead(&self) -> &OsStr

pub fn as_bytes(&self) -> &[u8]

pub fn basename(&self) -> &OsStr

Returns the basename of this path (the OsStr following the last / in the path). This OsStr won’t contain any instances of /.

See parent() for more info.

pub fn parent(&self) -> &Self

Returns the parent directory of this path (lexically speaking). The result is a Path with basename and the preceding slash removed, such that the following holds for any path.

let owned = OwnedPath::<Abs>::from("/my/path");
let path: &Path<Abs> = &owned;
let new_path = path.parent().join(Path::new(path.basename()));
assert_eq!(path, new_path);

Because this method is the counterpart of basename and basename won’t contain any /, the behavior when calling these methods on "/" is as follows:

assert_eq!(Path::root().basename(), "");
assert_eq!(Path::root().parent(), Path::root());

This behavior is also consistent with Unix defaults: the .. entry in the root directory refers to the root itself.

pub fn join<P: AsRef<Path<Rel>>>(&self, other: P) -> OwnedPath<S>

pub fn relative_to(&self, other: &Self) -> Option<&Path<Rel>>

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

Creates an Iterator over the components of a Path. This iterator produces Path<Rel>s representing each /-separated string in the Path, from left to right.

pub fn ancestors<'a>(&'a self) -> Ancestors<'a, S>

Creates an Iterator over the ancestors of a Path. This iterator produces Path<S>s representing each directory in the Path ordered with descending depth and ending with the Path itself.

impl Path<Rel>

pub fn dot_slash() -> &'static Path<Rel>

pub fn resolve(&self, target: OwnedPath<Abs>) -> OwnedPath<Abs>

pub fn resolve_root(&self) -> OwnedPath<Abs>

pub fn resolve_home(&self) -> Option<OwnedPath<Abs>>

pub fn resolve_cwd(&self) -> Option<OwnedPath<Abs>>

pub fn metadata( &self, relative_to: Directory, ) -> Result<Metadata, PathOrMetadataError>

pub fn metadata_no_follow( &self, relative_to: Directory, ) -> Result<Metadata, PathOrMetadataError>

Trait Implementations

impl<S: PathState> AsRef<Path<S>> for OwnedPath<S>

fn as_ref(&self) -> &Path<S>

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

impl<S: PathState> AsRef<Path<S>> for Path<S>

fn as_ref(&self) -> &Path<S>

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

impl<S: PathState> Borrow<Path<S>> for OwnedPath<S>

fn borrow(&self) -> &Path<S>

Immutably borrows from an owned value.

impl<S: PathState> Debug for Path<S>

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

Formats the value using the given formatter.

impl<S: PathState> From<&Path<S>> for OwnedPath<S>

fn from(value: &Path<S>) -> Self

Converts to this type from the input type.

impl<S: PathState> Ord for Path<S>

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

This method returns an Ordering between self and other.

impl<S: PathState> PartialEq<OwnedPath<S>> for Path<S>

fn eq(&self, other: &OwnedPath<S>) -> 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<S: PathState> PartialEq<Path<S>> for OwnedPath<S>

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

fn eq(&self, other: &Self) -> 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<S: PathState> PartialOrd<OwnedPath<S>> for Path<S>

fn partial_cmp(&self, other: &OwnedPath<S>) -> 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<S: PathState> PartialOrd<Path<S>> for OwnedPath<S>

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

fn partial_cmp(&self, other: &Self) -> 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<S: PathState> ToOwned for Path<S>

type Owned = OwnedPath<S>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<S: PathState> Eq for Path<S>