Struct ExecCommandInput 

pub struct ExecCommandInput {
    pub command: String,
    pub args: Vec<String>,
    pub cwd: Option<VirtualPath>,
    pub env: FxHashMap<String, String>,
    pub paths: Vec<VirtualPath>,
    pub shell: Option<String>,
    pub stream: bool,
    /* private fields */
}

Input passed to the exec_command host function.

Fields

command: String

The command or script to execute. Accepts an executable name available on PATH or a virtual path.

args: Vec<String>

Arguments to pass to the command.

cwd: Option<VirtualPath>

Override the current working directory.

env: FxHashMap<String, String>

Environment variables to pass to the command. Variables can customize behavior by appending one of the following characters to the name:

? - Will only set variable if it doesn’t exist in the current environment. ! - Will remove the variable from being inherited by the child process.

paths: Vec<VirtualPath>

List of real or virtual paths to prepend to the PATH environment variable when executing the command.

shell: Option<String>

Set the shell to execute the command with, for example “bash”.

stream: bool

Stream the output instead of capturing it.

Implementations

impl ExecCommandInput

pub fn command(self, value: impl Into<String>) -> Self

Sets the command field of this struct.

pub fn args(self, value: Vec<String>) -> Self

Sets the args field of this struct.

pub fn cwd(self, value: VirtualPath) -> Self

Sets the cwd field of this struct.

pub fn env(self, value: FxHashMap<String, String>) -> Self

Sets the env field of this struct.

pub fn paths(self, value: Vec<VirtualPath>) -> Self

Sets the paths field of this struct.

pub fn shell(self, value: impl Into<String>) -> Self

Sets the shell field of this struct.

pub fn stream(self) -> Self

Sets the stream field of this struct.

impl ExecCommandInput

pub fn new<C, I, V>(command: C, args: I) -> ExecCommandInput

where C: AsRef<str>, I: IntoIterator<Item = V>, V: AsRef<str>,

Create a new command that inherits and streams the output.

pub fn pipe<C, I, V>(command: C, args: I) -> ExecCommandInput

where C: AsRef<str>, I: IntoIterator<Item = V>, V: AsRef<str>,

Create a new command that pipes and captures the output.

pub fn inherit<C, I, V>(command: C, args: I) -> ExecCommandInput

where C: AsRef<str>, I: IntoIterator<Item = V>, V: AsRef<str>,

Create a new command that inherits and streams the output.

Trait Implementations

impl Clone for ExecCommandInput

fn clone(&self) -> ExecCommandInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecCommandInput

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

Formats the value using the given formatter.

impl Default for ExecCommandInput

fn default() -> ExecCommandInput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecCommandInput

where ExecCommandInput: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExecCommandInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExecCommandInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExecCommandInput