Struct RunRequest

pub struct RunRequest {
    pub command: String,
    pub arguments: Vec<String>,
    pub return_stdout: bool,
    pub return_stderr: bool,
}

The json-body schema for POST /api/run.

Serialized Example

{
 "command": "echo",
 "arguments": [
   "Hello",
   "World"
 ],
 "return_stderr": true,
 "return_stdout": false
}

Fields

command: String

The command as available on the path or a path to an executable.

arguments: Vec<String>

The arguments as passed to tokio::process::Command::args

Warning

Raw args are not supported. Avoid cmd.exe /C!

return_stdout: bool

true if the api should capture and return stdout. Defaults to false.

return_stderr: bool

true if the api should capture and return stderr. Defaults to false.

Trait Implementations

impl Debug for RunRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.