Struct AgentRunOptions 

pub struct AgentRunOptions {
    pub chat_options: Option<ChatOptions>,
    pub additional_tools: Vec<ToolDefinition>,
}

Per-run option overrides for a single SupportsAgentRun::run_with_options / SupportsAgentRun::run_stream call, merged over the agent’s build-time defaults.

Mirrors upstream run/run_stream per-call keyword arguments and .NET AgentRunOptions: the per-run ChatOptions take precedence over the agent’s defaults (via ChatOptions::merge, matching Python’s run_chat_options & ChatOptions(...)), and additional_tools are appended to the tool list for that call only.

Fields

chat_options: Option<ChatOptions>

Chat-option overrides merged over the agent’s defaults (per-run wins).

additional_tools: Vec<ToolDefinition>

Extra tools available only for this run, appended to the agent’s tools.

Declaration-only tools (no executor) surface their calls back to the caller instead of being executed locally — this is how a hosting frontend injects client-side tools (see the AG-UI router).

Implementations

impl AgentRunOptions

pub fn new() -> AgentRunOptions

Empty options (no overrides).

pub fn with_chat_options(self, options: ChatOptions) -> AgentRunOptions

Set the per-run chat-option overrides (merged over the agent defaults, per-run winning).

pub fn with_tool(self, tool: ToolDefinition) -> AgentRunOptions

Append a tool available only for this run.

pub fn with_tools( self, tools: impl IntoIterator<Item = ToolDefinition>, ) -> AgentRunOptions

Append multiple tools available only for this run.

pub fn is_empty(&self) -> bool

Whether these options carry no overrides at all. Used by the default SupportsAgentRun::run_with_options to decide whether to warn about ignoring options it cannot honor.

Trait Implementations

impl Clone for AgentRunOptions

fn clone(&self) -> AgentRunOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentRunOptions

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

Formats the value using the given formatter.

impl Default for AgentRunOptions

fn default() -> AgentRunOptions

Returns the “default value” for a type.