Struct Command 

pub struct Command {
    pub command_line: String,
    pub working_dir: Option<PathBuf>,
    pub env: HashMap<String, String>,
    pub timeout: Option<Duration>,
    pub capture_output: bool,
    pub max_output_bytes: Option<u64>,
}

A command to be executed in a shell session.

Fields

command_line: String

The command line to execute.

working_dir: Option<PathBuf>

Working directory override (if any).

env: HashMap<String, String>

Environment variables to set.

timeout: Option<Duration>

Maximum execution time.

capture_output: bool

Whether to capture output.

max_output_bytes: Option<u64>

Cap on the output the result keeps, in bytes.

None means [super::executor::DEFAULT_MAX_OUTPUT_BYTES]. There is no value meaning “unbounded” — see that constant.

Implementations

impl Command

pub fn new(command_line: impl Into<String>) -> Self

Create a new command with the given command line.

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

Set the working directory.

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

Add an environment variable.

pub fn envs<I, K, V>(self, vars: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Add multiple environment variables.

pub fn timeout(self, duration: Duration) -> Self

Set the execution timeout.

pub fn capture_output(self, capture: bool) -> Self

Set whether to capture output.

pub fn max_output_bytes(self, bytes: u64) -> Self

Cap the output the result keeps.

pub fn effective_timeout(&self) -> Duration

The deadline this command will actually run under.

timeout records what the caller asked for; this is what they get. Absent, it is [DEFAULT_TIMEOUT]; present, it is bounded by [MIN_TIMEOUT] and [MAX_TIMEOUT] — the range docs/openapi.json has published all along without anything enforcing it.

This is deliberately the only place the deadline is computed. It used to be worked out twice — once in the blocking core to time the command out, and once in execute_async to decide when a stalled streaming consumer stops being waited on. Two copies of one rule is a bug waiting for the first edit that reaches only one of them, and clamping was exactly such an edit: applied to the first alone, a command would have been killed at the ceiling while the stream went on being fed to a consumer for the hours the caller originally named.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Self

Returns the “default value” for a type.