Struct CommandExecParams 

pub struct CommandExecParams {

    pub command: Vec<String>,
    pub process_id: Option<String>,
    pub tty: bool,
    pub stream_stdin: bool,
    pub stream_stdout_stderr: bool,
    pub output_bytes_cap: Option<usize>,
    pub disable_output_cap: bool,
    pub disable_timeout: bool,
    pub timeout_ms: Option<i64>,
    pub cwd: Option<PathBuf>,
    pub env: Option<HashMap<String, Option<String>>>,
    pub size: Option<CommandExecTerminalSize>,
    pub sandbox_policy: Option<SandboxPolicy>,
    pub permission_profile: Option<String>,
}

Run a standalone command (argv vector) in the server sandbox without creating a thread or turn.

The final command/exec response is deferred until the process exits and is sent only after all command/exec/outputDelta notifications for that connection have been emitted.

Fields

command: Vec<String>

Command argv vector. Empty arrays are rejected.

process_id: Option<String>

Optional client-supplied, connection-scoped process id.

Required for tty, streamStdin, streamStdoutStderr, and follow-up command/exec/write, command/exec/resize, and command/exec/terminate calls. When omitted, buffered execution gets an internal id that is not exposed to the client.

tty: bool

Enable PTY mode.

This implies streamStdin and streamStdoutStderr.

stream_stdin: bool

Allow follow-up command/exec/write requests to write stdin bytes.

Requires a client-supplied processId.

stream_stdout_stderr: bool

Stream stdout/stderr via command/exec/outputDelta notifications.

Streamed bytes are not duplicated into the final response and require a client-supplied processId.

output_bytes_cap: Option<usize>

Optional per-stream stdout/stderr capture cap in bytes.

When omitted, the server default applies. Cannot be combined with disableOutputCap.

disable_output_cap: bool

Disable stdout/stderr capture truncation for this request.

Cannot be combined with outputBytesCap.

disable_timeout: bool

Disable the timeout entirely for this request.

Cannot be combined with timeoutMs.

timeout_ms: Option<i64>

Optional timeout in milliseconds.

When omitted, the server default applies. Cannot be combined with disableTimeout.

cwd: Option<PathBuf>

Optional working directory. Defaults to the server cwd.

env: Option<HashMap<String, Option<String>>>

Optional environment overrides merged into the server-computed environment.

Matching names override inherited values. Set a key to null to unset an inherited variable.

size: Option<CommandExecTerminalSize>

Optional initial PTY size in character cells. Only valid when tty is true.

sandbox_policy: Option<SandboxPolicy>

Optional sandbox policy for this command.

Uses the same shape as thread/turn execution sandbox configuration and defaults to the user’s configured policy when omitted. Cannot be combined with permissionProfile.

permission_profile: Option<String>

Optional active permissions profile id for this command.

Defaults to the user’s configured permissions when omitted. Cannot be combined with sandboxPolicy.

Trait Implementations

impl Clone for CommandExecParams

fn clone(&self) -> CommandExecParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandExecParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandExecParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExperimentalApi for CommandExecParams

fn experimental_reason(&self) -> Option<&'static str>

Returns a short reason identifier when an experimental method or field is used, or None when the value is entirely stable.

impl JsonSchema for CommandExecParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for CommandExecParams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommandExecParams

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 CommandExecParams

impl TS for CommandExecParams

type WithoutGenerics = CommandExecParams

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = CommandExecParams

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.