Struct ProjectInput 

#[non_exhaustive]
pub struct ProjectInput<'a> { /* private fields */ }

Process-like path inputs used to resolve a project root.

Build one with ProjectInput::new and the chainable setters. Project root resolution is best-effort and uses a stable fallback order:

1. cwd
2. parent of exe, for executables that are not known runtimes or tools
3. parents of absolute paths in cmd

Relative command-line arguments are ignored because they cannot be resolved safely without knowing the process working directory at the time the command started.

The home-directory ceiling is not part of the input. It is configured on StackDetector or passed to resolve_project_root directly.

Examples

use std::path::Path;
use what_stack::ProjectInput;

let input = ProjectInput::new()
    .cwd(Path::new("/workspace/api/src"))
    .exe(None);

Implementations

impl<'a> ProjectInput<'a>

pub const fn new() -> Self

Create an empty input with no path hints.

pub fn cwd(self, cwd: impl Into<Option<&'a Path>>) -> Self

Set the process working directory.

This is the most trustworthy project-root hint and is checked first. Accepts a &Path or an Option<&Path>.

pub fn exe(self, exe: impl Into<Option<&'a Path>>) -> Self

Set the process executable path.

The parent directory is searched when the working directory is missing or does not resolve to a project, unless the executable is a known runtime or tool such as node or python. A root found this way is ignored when it lies in a dot directory directly under the home ceiling, such as ~/.nvm or ~/.cargo. Accepts a &Path or an Option<&Path>.

pub const fn cmd(self, cmd: &'a [OsString]) -> Self

Set the process command-line arguments.

Only absolute path arguments are inspected, in their original order.

Trait Implementations

impl<'a> Clone for ProjectInput<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ProjectInput<'a>

impl<'a> Debug for ProjectInput<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ProjectInput<'a>

fn default() -> Self

Returns the “default value” for a type.