Struct ManifestPath

pub struct ManifestPath { /* private fields */ }

More or less [AbsPathBuf] with non-None parent.

We use it to store path to Cargo.toml, as we frequently use the parent dir as a working directory to spawn various commands, and its nice to not have to .unwrap() everywhere.

This could have been named AbsNonRootPathBuf, as we don’t enforce that this stores manifest files in particular, but we only use this for manifests at the moment in practice.

Implementations

impl ManifestPath

pub fn parent(&self) -> &AbsPath

pub fn canonicalize(&self) -> !

pub fn is_rust_manifest(&self) -> bool

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 ManifestPath

fn as_ref(&self) -> &AbsPath

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

impl AsRef<OsStr> for ManifestPath

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for ManifestPath

fn as_ref(&self) -> &Path

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

impl Borrow<AbsPath> for ManifestPath

fn borrow(&self) -> &AbsPath

Immutably borrows from an owned value.

impl Clone for ManifestPath

fn clone(&self) -> ManifestPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ManifestPath

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

Formats the value using the given formatter.

impl Deref for ManifestPath

type Target = AbsPath

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ManifestPath

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

Formats the value using the given formatter.

impl From<ManifestPath> for AbsPathBuf

fn from(it: ManifestPath) -> Self

Converts to this type from the input type.

impl Hash for ManifestPath

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 ManifestPath

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

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

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

type Error = AbsPathBuf

The type returned in the event of a conversion error.

fn try_from(file: AbsPathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ManifestPath

impl StructuralPartialEq for ManifestPath