Skip to main content

RunRequest

Struct RunRequest 

Source
pub struct RunRequest {
Show 13 fields pub prompt: String, pub cwd: PathBuf, pub model: Option<String>, pub timeout: Duration, pub env_remove: Vec<OsString>, pub json_schema: Option<Value>, pub tool_policy: ToolPolicy, pub mcp_servers: Vec<McpServer>, pub env: Vec<(OsString, OsString)>, pub system_prompt: Option<String>, pub persist_session: bool, pub resume: Option<String>, pub on_event: Option<EventHandler>,
}
Expand description

A single, fresh CLI run.

Build it with struct update syntax so new optional fields do not break callers: RunRequest { prompt, cwd, ..RunRequest::default() }.

Fields§

§prompt: String§cwd: PathBuf§model: Option<String>

Model ID for the chosen provider, or None for its configured default.

§timeout: Duration§env_remove: Vec<OsString>

Environment variable names to remove from the child only.

§json_schema: Option<Value>

Optional JSON Schema. Claude and Codex enforce it; Devin and OpenCode leave validation to the caller.

§tool_policy: ToolPolicy

Which tools the agent may use.

§mcp_servers: Vec<McpServer>

MCP servers for this run. Claude and Codex only; with a policy other than ToolPolicy::Default, MCP servers from the user’s own CLI configuration are ignored.

§env: Vec<(OsString, OsString)>

Extra environment variables for the child only, set after env_remove is applied.

§system_prompt: Option<String>

Instructions appended to the CLI’s own system prompt (Claude: --append-system-prompt, Codex: developer_instructions). Devin and OpenCode receive it before the prompt.

§persist_session: bool

Keep the CLI’s session so a later run can resume it (default: ephemeral, as before 0.4).

§resume: Option<String>

Continue the session returned earlier in RunResult::session_id. Implies persistence. Claude and Codex resume in the same cwd; OpenCode by id; Devin rejects it.

§on_event: Option<EventHandler>

Called with progress while the run goes on (Claude streams text; Codex and OpenCode report whole messages and tool calls; Devin reports nothing).

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 Default for RunRequest

Source§

fn default() -> Self

An empty prompt in the current directory with a five-minute timeout.

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.