Skip to main content

Op

Enum Op 

Source
pub enum Op {
Show 32 variants SendMessage {
Show 22 fields max_output_tokens: Option<NonZeroU32>, content: String, images: Vec<RuntimeImageInput>, mode: String, model: Option<String>, model_provider: Option<String>, allowed_tools: Option<Vec<String>>, dynamic_tools: Vec<DynamicToolSpec>, provenance: String, compaction: Option<Box<CompactionPolicy>>, goal_objective: Option<String>, goal_token_budget: Option<u32>, goal_status: String, reasoning_effort: Option<String>, reasoning_effort_auto: bool, auto_model: bool, allow_shell: bool, trust_mode: bool, auto_approve: bool, approval_mode: String, translation_enabled: bool, verbosity: Option<String>,
}, Steer { content: String, }, ContinueGoal { dynamic_tools: Vec<DynamicToolSpec>, engine_schedule_id: Option<u64>, }, RunShellCommand { command: String, mode: String, allow_shell: bool, trust_mode: bool, auto_approve: bool, approval_mode: String, }, SetGoalStatus { status: String, clear: bool, goal_id: Option<String>, }, SetGoalObjective { objective: String, token_budget: Option<u32>, goal_id: Option<String>, }, Cancel, Shutdown, PreviewOutboundRequest {
Show 16 fields json: bool, base_prompt_only: bool, mode: String, allow_shell: bool, trust_mode: bool, auto_approve: bool, approval_mode: String, allowed_tools: Option<Vec<String>>, dynamic_tools: Vec<DynamicToolSpec>, provenance: String, requested_model: String, requested_reasoning: String, auto_model: bool, hypothetical_prompt_supplied: bool, hypothetical_prompt: Option<String>, unresolved: Option<String>,
}, ListSubAgents, GetSubAgentSettlement, CancelSubAgent { agent_id: String, }, FollowUpSubAgent { agent_id: String, text: String, }, ChangeMode { mode: String, allow_shell: bool, trust_mode: bool, auto_approve: bool, approval_mode: String, configured_sandbox_mode: Option<String>, }, SetModel { model: String, mode: String, route_limits: Option<RouteLimits>, }, SetCompaction { config: CompactionPolicy, }, SetPermissionRuleset { ruleset: Value, }, SetStreamChunkTimeout { timeout_secs: u64, }, SetSubagentRuntimeConfig { enabled: bool, max_subagents: u64, launch_concurrency: u64, max_spawn_depth: u32, api_timeout_secs: u64, heartbeat_timeout_secs: u64, }, SetSearchProvider { provider: String, }, SetFleetRoster { member_ids: Vec<String>, exact_selection: bool, load_error: Option<String>, }, SyncSession { engine_session_id: Option<String>, messages: Vec<Value>, system_prompt: Option<Value>, system_prompt_override: bool, model: String, workspace: PathBuf, mode: String, }, CompactContext { id: String, model: String, model_provider: String, compaction: CompactionPolicy, }, CancelCompaction { id: String, }, GetSessionSnapshot, GetProviderRuntimeStatus, BootstrapMcp, RetryMcpServer { name: String, }, ReloadMcp { config_path: PathBuf, }, PurgeContext, EditLastTurn { new_message: String, }, SetAdvisorEnabled { enabled: bool, },
}
Expand description

Operations that can be submitted to the core engine. This is the protocol view of crates/tui/src/core/ops::Op — same lifecycle, same provenance gate — but serializable and free of mpsc / oneshot fields. In-process callers convert at the boundary; out-of-process callers send the JSON directly.

Variants§

§

SendMessage

Drive one model turn: role=user content plus the resolved route receipt the engine will freeze at the client-freeze boundary. Headless and TUI must produce byte-identical MessageRequests for identical Op::SendMessage payloads.

Fields

§max_output_tokens: Option<NonZeroU32>
§content: String
§mode: String

Effective mode for this turn ("plan" | "agent" | "operate" etc).

§model: Option<String>

Optional explicit route/model the caller resolved already (mirrors ResolvedRuntimeRoute in crates_tui::route_runtime). None means “use the thread’s current route”.

§model_provider: Option<String>
§allowed_tools: Option<Vec<String>>

Tool restriction from slash-command frontmatter.

§dynamic_tools: Vec<DynamicToolSpec>

Runtime-supplied dynamic tools for this turn only.

§provenance: String

Structural input provenance — only external_user may inherit YOLO/auto-approval authority (mirrors UserInputProvenance).

§compaction: Option<Box<CompactionPolicy>>

Compaction policy carried atomically with the route receipt. Boxed only to keep the enum small; the wire shape is unchanged.

§goal_objective: Option<String>
§goal_token_budget: Option<u32>
§goal_status: String

active | paused | complete | blocked.

§reasoning_effort: Option<String>

"off" | "low" | "medium" | "high" | "max"; None = provider default.

§reasoning_effort_auto: bool
§auto_model: bool
§allow_shell: bool
§trust_mode: bool
§auto_approve: bool
§approval_mode: String

auto | bypass | suggest | never.

§translation_enabled: bool
§verbosity: Option<String>
§

Steer

Steer an in-flight turn with additional user content (drains into the turn loop’s rx_steer channel).

Fields

§content: String
§

ContinueGoal

Re-check and dispatch a goal continuation (synthetic turn that continues the same logical goal run).

Fields

§dynamic_tools: Vec<DynamicToolSpec>
§engine_schedule_id: Option<u64>

Engine-owned coalescing token; direct callers send None.

Enforced, not merely documented: the engine mints these on an in-process channel (tx_op.try_send) and they never cross serde, so any value arriving through deserialization came from outside. The IDs are predictable per-session counters, and a matching guess is treated as an already-delayed internal token – it would consume the pending schedule and skip the host-injected quiet period. Wire input is therefore always dropped to None.

§

RunShellCommand

Execute a local composer shell command without a model turn.

Fields

§command: String
§mode: String
§allow_shell: bool
§trust_mode: bool
§auto_approve: bool
§approval_mode: String
§

SetGoalStatus

Set goal status without dispatching a model turn.

Fields

§status: String
§clear: bool
§goal_id: Option<String>
§

SetGoalObjective

Set (or replace) the active goal objective and start goal work.

Fields

§objective: String
§token_budget: Option<u32>
§goal_id: Option<String>
§

Cancel

§

Shutdown

§

PreviewOutboundRequest

Describe the exact request the next turn would send without sending it (/dryrun / /preview-request, #1004). Headless and TUI must render identical manifests for identical inputs.

Fields

§json: bool
§base_prompt_only: bool
§mode: String
§allow_shell: bool
§trust_mode: bool
§auto_approve: bool
§approval_mode: String
§allowed_tools: Option<Vec<String>>
§dynamic_tools: Vec<DynamicToolSpec>
§provenance: String
§requested_model: String

The model selector the user chose (auto when auto routing).

§requested_reasoning: String
§auto_model: bool
§hypothetical_prompt_supplied: bool
§hypothetical_prompt: Option<String>

Model-facing text of the hypothetical next message, when the host planner resolved one.

§unresolved: Option<String>

Why no exact next turn exists, when it does not.

§

ListSubAgents

§

GetSubAgentSettlement

Inspect live children and pending handbacks at the Engine’s idle boundary. The host owns the response channel; it is not wire input.

§

CancelSubAgent

Fields

§agent_id: String
§

FollowUpSubAgent

Fields

§agent_id: String
§text: String
§

ChangeMode

Fields

§mode: String
§allow_shell: bool
§trust_mode: bool
§auto_approve: bool
§approval_mode: String
§configured_sandbox_mode: Option<String>
§

SetModel

Fields

§model: String
§mode: String
§route_limits: Option<RouteLimits>
§

SetCompaction

Fields

§

SetPermissionRuleset

Legacy serialized permission-update operation, retained for wire compatibility. The in-process runtime now publishes directly through its shared policy store instead of queuing a second replacement.

Fields

§ruleset: Value
§

SetStreamChunkTimeout

Fields

§timeout_secs: u64
§

SetSubagentRuntimeConfig

Fields

§enabled: bool
§max_subagents: u64
§launch_concurrency: u64
§max_spawn_depth: u32
§api_timeout_secs: u64
§heartbeat_timeout_secs: u64
§

SetSearchProvider

SearchProvider in snake_case.

Fields

§provider: String
§

SetFleetRoster

Replace the engine’s merged Fleet roster. Only the roster’s identity crosses: member ids in precedence order plus the load state.

Fields

§member_ids: Vec<String>
§exact_selection: bool
§load_error: Option<String>
§

SyncSession

Sync engine session state (resume/load). messages are transcript Messages and system_prompt a SystemPrompt, both serialized.

Fields

§engine_session_id: Option<String>
§messages: Vec<Value>
§system_prompt: Option<Value>
§system_prompt_override: bool
§model: String
§workspace: PathBuf
§mode: String
§

CompactContext

Run context compaction on one exact provider route.

Fields

§model: String
§model_provider: String
§compaction: CompactionPolicy
§

CancelCompaction

Fields

§

GetSessionSnapshot

Request a session snapshot; the reply travels out-of-band.

§

GetProviderRuntimeStatus

Request provider concurrency state; the reply travels out-of-band.

§

BootstrapMcp

Populate the engine-owned MCP pool once at boot; reply out-of-band.

§

RetryMcpServer

Fields

§name: String
§

ReloadMcp

Fields

§config_path: PathBuf
§

PurgeContext

§

EditLastTurn

Fields

§new_message: String
§

SetAdvisorEnabled

Fields

§enabled: bool

Implementations§

Source§

impl Op

Source

pub fn is_send_message(&self) -> bool

Source

pub fn kind_str(&self) -> &'static str

Trait Implementations§

Source§

impl Clone for Op

Source§

fn clone(&self) -> Op

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 Op

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Op

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Op

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Op

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Op

Auto Trait Implementations§

§

impl Freeze for Op

§

impl RefUnwindSafe for Op

§

impl Send for Op

§

impl Sync for Op

§

impl Unpin for Op

§

impl UnsafeUnpin for Op

§

impl UnwindSafe for Op

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.