Struct AbsPath

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

Wrapper around an absolute [Utf8Path].

Implementations

impl AbsPath

pub fn assert(path: &Utf8Path) -> &AbsPath

Wrap the given absolute path in AbsPath

Panics

Panics if path is not absolute.

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

Equivalent of [Utf8Path::parent] for AbsPath.

pub fn absolutize(&self, path: impl AsRef<Utf8Path>) -> AbsPathBuf

Equivalent of [Utf8Path::join] for AbsPath with an additional normalize step afterwards.

pub fn join(&self, path: impl AsRef<Utf8Path>) -> AbsPathBuf

Equivalent of [Utf8Path::join] for AbsPath.

pub fn normalize(&self) -> AbsPathBuf

Normalize the given path:

• Removes repeated separators: /a//b becomes /a/b
• Removes occurrences of . and resolves ...
• Removes trailing slashes: /a/b/ becomes /a/b.

Example

let abs_path_buf = AbsPathBuf::assert("/a/../../b/.//c//".into());
let normalized = abs_path_buf.normalize();
assert_eq!(normalized, AbsPathBuf::assert("/b/c".into()));

pub fn to_path_buf(&self) -> AbsPathBuf

Equivalent of [Utf8Path::to_path_buf] for AbsPath.

pub fn canonicalize(&self) -> !

pub fn strip_prefix(&self, base: &AbsPath) -> Option<&RelPath>

Equivalent of [Utf8Path::strip_prefix] for AbsPath.

Returns a relative path.

pub fn starts_with(&self, base: &AbsPath) -> bool

pub fn ends_with(&self, suffix: &RelPath) -> bool

pub fn name_and_extension(&self) -> Option<(&str, Option<&str>)>

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

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

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

pub fn as_os_str(&self) -> &OsStr

pub fn as_str(&self) -> &str

pub fn display(&self) -> !

👎Deprecated: use Display instead

pub fn exists(&self) -> !

👎Deprecated: use std::fs::metadata().is_ok() instead

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

Trait Implementations

impl AsRef<AbsPath> for AbsPathBuf

fn as_ref(&self) -> &AbsPath

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

impl AsRef<OsStr> for AbsPath

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for AbsPath

fn as_ref(&self) -> &Path

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

impl AsRef<Utf8Path> for AbsPath

fn as_ref(&self) -> &Utf8Path

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

impl Borrow<AbsPath> for AbsPathBuf

fn borrow(&self) -> &AbsPath

Immutably borrows from an owned value.

impl Debug for AbsPath

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

Formats the value using the given formatter.

impl Display for AbsPath

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

Formats the value using the given formatter.

impl Hash for AbsPath

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

where __H: Hasher,

Feeds this value into the given Hasher.

impl Ord for AbsPath

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

This method returns an Ordering between self and other.

impl PartialEq<AbsPath> for VfsPath

fn eq(&self, other: &AbsPath) -> 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<P> PartialEq<P> for AbsPath

where P: AsRef<Path> + ?Sized,

fn eq(&self, other: &P) -> 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 PartialEq<VfsPath> for AbsPath

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

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

type Owned = AbsPathBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> <AbsPath as ToOwned>::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<'a> TryFrom<&'a Utf8Path> for &'a AbsPath

type Error = &'a Utf8Path

The type returned in the event of a conversion error.

fn try_from(path: &'a Utf8Path) -> Result<&'a AbsPath, &'a Utf8Path>

Performs the conversion.

impl Eq for AbsPath