Struct which::Path

pub struct Path { /* fields omitted */ }

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

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

It can be beneficial to use which::Path instead of std::path::Path when you want the type system to enforce the need for a path that exists and points to a binary that is executable.

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

Implementations

impl Path

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

Returns the path of an executable binary by name.

This calls which and maps the result into a Path.

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

Returns the paths of all executable binaries by a name.

this calls which_all and maps the results into Paths.

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

Returns the 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 maps the result into a Path.

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

Returns all 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 maps the results into a Path.

pub fn as_path(&self) -> &Path

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

pub fn into_path_buf(self) -> PathBuf

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

Trait Implementations

impl AsRef<OsStr> for Path

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Deref for Path

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Path

Dereferences the value.

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl PartialEq<Path> for PathBuf

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

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 Path

impl StructuralPartialEq for Path