Struct WhichConfig

pub struct WhichConfig<F = Noop> { /* private fields */ }

A wrapper containing all functionality in this crate.

Implementations

impl WhichConfig<Noop>

pub fn new() -> Self

impl<'a, F: NonFatalErrorHandler + 'a> WhichConfig<F>

pub fn system_cwd(self, use_cwd: bool) -> Self

Whether or not to use the current working directory. true by default.

Panics

If regex was set previously, and you’ve just passed in use_cwd: true, this will panic.

pub fn custom_cwd(self, cwd: PathBuf) -> Self

Sets a custom path for resolving relative paths.

Panics

If regex was set previously, this will panic.

pub fn regex(self, regex: ()) -> Self

Sets the path name regex to search for. You MUST call this, or Self::binary_name prior to searching.

When Regex is disabled this function takes the unit type as a stand in. The parameter will change when Regex is enabled.

Panics

If the regex feature wasn’t turned on for this crate this will always panic. Additionally if a cwd (aka current working directory) or binary_name was set previously, this will panic, as those options are incompatible with regex.

pub fn binary_name(self, name: OsString) -> Self

Sets the path name to search for. You MUST call this, or Self::regex prior to searching.

Panics

If a regex was set previously this will panic as this is not compatible with regex.

pub fn custom_path_list(self, custom_path_list: OsString) -> Self

Uses the given string instead of the PATH env variable.

pub fn system_path_list(self) -> Self

Uses the PATH env variable. Enabled by default.

pub fn nonfatal_error_handler<NewF>(self, handler: NewF) -> WhichConfig<NewF>

Sets a closure that will receive non-fatal errors. You can also pass in other types that implement NonFatalErrorHandler.

Example

let mut nonfatal_errors = Vec::new();

WhichConfig::new()
    .binary_name("tar".into())
    .nonfatal_error_handler(|e| nonfatal_errors.push(e))
    .all_results()
    .unwrap()
    .collect::<Vec<_>>();

if !nonfatal_errors.is_empty() {
    println!("nonfatal errors encountered: {nonfatal_errors:?}");
}

You could also log it if you choose

WhichConfig::new()
    .binary_name("tar".into())
    .nonfatal_error_handler(|e| eprintln!("{e}"))
    .all_results()
    .unwrap()
    .collect::<Vec<_>>();

pub fn first_result(self) -> Result<PathBuf>

Finishes configuring, runs the query and returns the first result.

pub fn all_results(self) -> Result<impl Iterator<Item = PathBuf> + 'a>

Finishes configuring, runs the query and returns all results.

Trait Implementations

impl<F: Default> Default for WhichConfig<F>

fn default() -> Self

Returns the “default value” for a type.