Struct Plan 

pub struct Plan {
    pub program: OsString,
    pub args: Vec<OsString>,
    pub cwd: Option<PathBuf>,
}

What to run, resolved from whatever a plugin answered or the project defined.

Deliberately this crate’s own type rather than the contract’s: execution needs three fields and no knowledge of plugins, and keeping it that way is what lets the whole run path be tested without a plugin at all.

Fields

program: OsString

The executable, as written: a bare name (looked up on PATH), an absolute path, or one relative to Plan::cwd.

args: Vec<OsString>

Arguments, in order, handed over verbatim.

cwd: Option<PathBuf>

Where to run it. None means the fallback the caller passes to run.

Implementations

impl Plan

pub fn new(program: impl Into<OsString>) -> Self

Name the executable.

pub fn arg(self, arg: impl Into<OsString>) -> Self

Append one argument.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Append a batch of arguments.

pub fn cwd(self, dir: impl Into<PathBuf>) -> Self

Override the working directory.

pub fn working_dir<'a>(&'a self, fallback: &'a Path) -> &'a Path

The working directory this will actually run in.

pub fn display(&self) -> String

The whole command line, for a message or a test.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl Default for Plan

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Plan

impl PartialEq for Plan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Plan