Skip to main content

RunOptions

Struct RunOptions 

Source
pub struct RunOptions {
    pub model: String,
    pub system_prompt: String,
    pub allowed_tools: Option<Vec<String>>,
    pub disallowed_tools: Vec<String>,
    pub max_turns: Option<u32>,
    pub max_budget_usd: Option<f64>,
    pub effort: EffortLevel,
    pub permission_mode: PermissionMode,
    pub pre_tool_hook: Option<Arc<dyn PreToolHook>>,
    pub session_id: Option<String>,
    pub base_url: String,
    pub compaction: Option<CompactionConfig>,
}
Expand description

Configuration for an agent run.

Mirrors ClaudeAgentOptions / Options from the Claude Agent SDK, scoped to the fields meaningful for a non-streaming OpenAI-compatible loop.

Fields§

§model: String§system_prompt: String§allowed_tools: Option<Vec<String>>

If Some, only listed tools may be invoked. Tools not on the list are hidden from the model entirely.

§disallowed_tools: Vec<String>

Tools listed here are hidden from the model and any call is denied.

§max_turns: Option<u32>§max_budget_usd: Option<f64>§effort: EffortLevel§permission_mode: PermissionMode§pre_tool_hook: Option<Arc<dyn PreToolHook>>§session_id: Option<String>§base_url: String§compaction: Option<CompactionConfig>

Opt-in history compaction. None (default) disables compaction — the full conversation is resent every turn. See CompactionConfig.

Implementations§

Source§

impl RunOptions

Source

pub fn new(model: impl Into<String>) -> Self

Source

pub fn system_prompt(self, p: impl Into<String>) -> Self

Source

pub fn max_turns(self, n: u32) -> Self

Source

pub fn max_budget_usd(self, b: f64) -> Self

Source

pub fn effort(self, e: EffortLevel) -> Self

Source

pub fn permission_mode(self, m: PermissionMode) -> Self

Source

pub fn allowed_tools<I, S>(self, tools: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn disallowed_tools<I, S>(self, tools: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn pre_tool_hook(self, hook: Arc<dyn PreToolHook>) -> Self

Source

pub fn session_id(self, id: impl Into<String>) -> Self

Source

pub fn base_url(self, url: impl Into<String>) -> Self

Source

pub fn compaction(self, cfg: CompactionConfig) -> Self

Enable natural-language history compaction with the given config.

Trait Implementations§

Source§

impl Clone for RunOptions

Source§

fn clone(&self) -> RunOptions

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more