Struct AbsPathBuf

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

A Utf8PathBuf that is guaranteed to be absolute.

Implementations

impl AbsPathBuf

pub fn assert(path: Utf8PathBuf) -> AbsPathBuf

Wrap the given absolute path in AbsPathBuf

Panics

Panics if path is not absolute.

pub fn assert_utf8(path: PathBuf) -> AbsPathBuf

Wrap the given absolute path in AbsPathBuf

Panics

Panics if path is not absolute.

pub fn as_path(&self) -> &AbsPath

Coerces to an AbsPath slice.

Equivalent of Utf8PathBuf::as_path for AbsPathBuf.

pub fn pop(&mut self) -> bool

Equivalent of Utf8PathBuf::pop for AbsPathBuf.

Note that this won’t remove the root component, so self will still be absolute.

pub fn push<P: AsRef<Utf8Path>>(&mut self, suffix: P)

Equivalent of PathBuf::push for AbsPathBuf.

Extends self with path.

If path is absolute, it replaces the current path.

On Windows:

• if path has a root but no prefix (e.g., \windows), it replaces everything except for the prefix (if any) of self.
• if path has a prefix but no root, it replaces self.
• if self has a verbatim prefix (e.g. \\?\C:\windows) and path is not empty, the new path is normalized: all references to . and .. are removed.

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

Methods from Deref<Target = AbsPath>

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 AbsPathBuf

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for AbsPathBuf

fn as_ref(&self) -> &Path

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

impl AsRef<Utf8Path> for AbsPathBuf

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 Clone for AbsPathBuf

fn clone(&self) -> AbsPathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AbsPathBuf

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

Formats the value using the given formatter.

impl Deref for AbsPathBuf

type Target = AbsPath

The resulting type after dereferencing.

fn deref(&self) -> &AbsPath

Dereferences the value.

impl Display for AbsPathBuf

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

Formats the value using the given formatter.

impl From<AbsPathBuf> for PathBuf

fn from(AbsPathBuf: AbsPathBuf) -> PathBuf

Converts to this type from the input type.

impl From<AbsPathBuf> for Utf8PathBuf

fn from(AbsPathBuf: AbsPathBuf) -> Utf8PathBuf

Converts to this type from the input type.

impl Hash for AbsPathBuf

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 AbsPathBuf

fn cmp(&self, other: &AbsPathBuf) -> 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.

impl<P: AsRef<Path> + ?Sized> PartialEq<P> for AbsPathBuf

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 PartialOrd for AbsPathBuf

fn partial_cmp(&self, other: &AbsPathBuf) -> 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 TryFrom<&str> for AbsPathBuf

type Error = Utf8PathBuf

The type returned in the event of a conversion error.

fn try_from(path: &str) -> Result<AbsPathBuf, Utf8PathBuf>

Performs the conversion.

impl TryFrom<Utf8PathBuf> for AbsPathBuf

type Error = Utf8PathBuf

The type returned in the event of a conversion error.

fn try_from(path_buf: Utf8PathBuf) -> Result<AbsPathBuf, Utf8PathBuf>

Performs the conversion.

impl Eq for AbsPathBuf