Struct which::CanonicalPath

pub struct CanonicalPath { /* fields omitted */ }

An owned, immutable wrapper around a PathBuf containing the canonical path of an executable.

The constructed PathBuf is the result of which or which_in followed by Path::canonicalize, but CanonicalPath has the advantage of being a type distinct from std::path::Path and std::path::PathBuf.

It can be beneficial to use CanonicalPath instead of std::path::Path when you want the type system to enforce the need for a path that exists, points to a binary that is executable, is absolute, has all components normalized, and has all symbolic links resolved

Since CanonicalPath implements Deref for std::path::Path, all methods on &std::path::Path are also available to &CanonicalPath values.

Implementations

impl CanonicalPath

pub fn new<T: AsRef<OsStr>>(binary_name: T) -> Result<CanonicalPath>

Returns the canonical path of an executable binary by name.

This calls which and Path::canonicalize and maps the result into a CanonicalPath.

pub fn all<T: AsRef<OsStr>>(
    binary_name: T
) -> Result<impl Iterator<Item = Result<CanonicalPath>>>

Returns the canonical paths of an executable binary by name.

This calls which_all and Path::canonicalize and maps the results into CanonicalPaths.

pub fn new_in<T, U, V>(
    binary_name: T,
    paths: Option<U>,
    cwd: V
) -> Result<CanonicalPath> where
    T: AsRef<OsStr>,
    U: AsRef<OsStr>,
    V: AsRef<Path>, 

Returns the canonical path of an executable binary by name in the path list paths and using the current working directory cwd to resolve relative paths.

This calls which_in and Path::canonicalize and maps the result into a CanonicalPath.

pub fn all_in<T, U, V>(
    binary_name: T,
    paths: Option<U>,
    cwd: V
) -> Result<impl Iterator<Item = Result<CanonicalPath>>> where
    T: AsRef<OsStr>,
    U: AsRef<OsStr>,
    V: AsRef<Path>, 

Returns all of the canonical paths of an executable binary by name in the path list paths and using the current working directory cwd to resolve relative paths.

This calls which_in_all and Path::canonicalize and maps the result into a CanonicalPath.

pub fn as_path(&self) -> &Path

Returns a reference to a std::path::Path.

pub fn into_path_buf(self) -> PathBuf

Consumes the which::CanonicalPath, yielding its underlying std::path::PathBuf.

Trait Implementations

impl AsRef<OsStr> for CanonicalPath

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for CanonicalPath

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for CanonicalPath

fn clone(&self) -> CanonicalPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalPath

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

Formats the value using the given formatter.

impl Deref for CanonicalPath

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Path

Dereferences the value.

impl PartialEq<CanonicalPath> for CanonicalPath

fn eq(&self, other: &CanonicalPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CanonicalPath) -> bool

This method tests for !=.

impl PartialEq<CanonicalPath> for PathBuf

fn eq(&self, other: &CanonicalPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<PathBuf> for CanonicalPath

fn eq(&self, other: &PathBuf) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for CanonicalPath

impl StructuralPartialEq for CanonicalPath