Struct RunOptions 

#[non_exhaustive]
pub struct RunOptions {
    pub cancellation: CancellationToken,
    pub controls: TurnControls,
}

Everything one Session::run_with_options call can override. Defaults (RunOptions::default()) reproduce plain Session::run: an uncancellable turn on the agent’s default model.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cancellation: CancellationToken

Clone this before calling and cancel the clone from elsewhere to stop the turn — see CancellationToken.

controls: TurnControls

Per-turn model/reasoning overrides — see TurnControls.

Implementations

impl RunOptions

pub fn new() -> Self

Defaults: uncancellable, on the agent’s own model.

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

Stop the turn from elsewhere — see CancellationToken.

pub fn controls(self, controls: TurnControls) -> Self

Per-turn model/reasoning overrides — see TurnControls.

Trait Implementations

impl Default for RunOptions

fn default() -> Self

Returns the “default value” for a type.