Struct RunOptions 

pub struct RunOptions { /* private fields */ }

Available on crate features async and conversation only.

Optional knobs for the agent loop.

Build via RunOptions::default and chain setters; see method docs.

Implementations

impl RunOptions

pub fn new() -> Self

Equivalent to Self::default.

pub fn max_iterations(self, max: u32) -> Self

Maximum total iterations of the model loop. Default 16.

pub fn on_iteration<F>(self, hook: F) -> Self

where F: Fn(&Message, u32) + Send + Sync + 'static,

Hook invoked after each messages.create response. Receives the response and the 1-indexed iteration number. Useful for streaming progress to the UI or recording fine-grained traces.

pub fn on_checkpoint<F>(self, hook: F) -> Self

where F: Fn(&Conversation) + Send + Sync + 'static,

Hook invoked at the end of every iteration with a borrowed snapshot of the Conversation – after the assistant turn and any tool_result turn have been appended.

Resumability: persist the conversation here and resume after a process restart by passing the deserialized Conversation back into Client::run. The conversation is the source of truth for the loop; no additional state needs to be saved. Iteration state lives on the stack and is reconstructable from turn count alone.

pub fn parallel_tool_dispatch(self, parallel: bool) -> Self

Whether to dispatch the tool_use blocks within a single assistant turn concurrently (default true). Set to false to dispatch sequentially – useful when tools have ordering side effects (e.g. shared mutable state) or when serial output is easier to debug.

pub fn cost_budget(self, max_usd: f64, pricing: PricingTable) -> Self

Available on crate feature pricing only.

Cap cumulative spend on the conversation. After each turn the runner computes Conversation::cost against pricing and aborts with Error::CostBudgetExceeded if the cumulative cost exceeds max_usd.

pub fn cancel_token(self, token: CancellationToken) -> Self

Attach a cancellation token. Checked at the top of every iteration; if cancelled, the loop returns Error::Cancelled before issuing the next request.

pub fn with_approver(self, approver: Arc<dyn ToolApprover>) -> Self

Attach a ToolApprover. Consulted before every tool dispatch; the verdict can approve, approve with rewritten input, substitute a result, deny (with a reason surfaced to the model as is_error = true), or stop the entire loop with Error::ToolApprovalStopped.

pub fn with_approver_fn<F, Fut>(self, handler: F) -> Self

where F: Fn(&str, &Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = ApprovalDecision> + Send + 'static,

Closure-based shortcut for Self::with_approver.

pub fn max_iterations_value(&self) -> u32

Borrow the configured iteration cap.

Trait Implementations

impl Debug for RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.