Skip to main content

RunRequest

Struct RunRequest 

Source
pub struct RunRequest {
    pub program: AbsolutePath,
    pub args: Vec<OsString>,
    pub env: BTreeMap<OsString, OsString>,
    pub cwd: AbsolutePath,
    pub stdin: Option<Vec<u8>>,
    pub capture: CaptureMode,
    pub echo: bool,
    pub tree: bool,
    pub terminal: bool,
}
Expand description

One command for a Tracer to run.

The request is exact: the tracer adds nothing to it and looks nothing up.

Fields§

§program: AbsolutePath

The exact path of the program to run. The engine has already resolved a bare program name through the task’s PATH.

§args: Vec<OsString>

The argument vector the program receives, starting with its argv[0].

§env: BTreeMap<OsString, OsString>

The exact environment of the process; nothing else is inherited.

§cwd: AbsolutePath

The absolute working directory of the process.

§stdin: Option<Vec<u8>>

The content written to standard input, or None to connect /dev/null; a request that keeps the terminal (RunRequest::terminal) connects neither, and its command reads the standard input of the process that runs the tracer.

§capture: CaptureMode

How standard output and standard error are captured.

§echo: bool

Whether output is also echoed live, through the EchoSink given to Tracer::run, while it is captured.

§tree: bool

Whether the result also holds the ProcessTree of the run, and a failed start the tree of its one process. Off unless set: builds never set it, so the tracer does not read the arguments of exec calls or keep each program’s observations for them.

§terminal: bool

Whether the command keeps the terminal: it uses the standard input, output and error of the process that runs the tracer, and stays in that process’s process group and session, so a terminal’s input and signals reach it as they would without kizz. Nothing is captured or echoed, the result’s output is empty, and RunRequest::stdin, RunRequest::capture and RunRequest::echo mean nothing: the output stays in the empty shape of the capture mode. Off unless set: builds never set it, so a command of a build runs in a process group of its own, with pipes or /dev/null as its standard streams, and a terminal’s Ctrl-C reaches only kizz.

Trait Implementations§

Source§

impl Clone for RunRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RunRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RunRequest

Source§

impl PartialEq for RunRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RunRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.