Enum ToolExecutionMode 

pub enum ToolExecutionMode {
    Standard,
    Background {
        formatter: Option<Arc<dyn ResultFormatter>>,
        scheduling: Option<FunctionResponseScheduling>,
    },
}

Execution mode for a tool.

• Standard: the tool runs inline and the model waits for the result before continuing.
• Background: the tool is spawned as a background task. An immediate “running” acknowledgment is sent to the model, and the final result is delivered asynchronously when the task completes.

With the L2 Fluent API

Live::builder()
    .tools(dispatcher)
    .tool_background("search_kb")           // uses DefaultResultFormatter
    .tool_background_with_formatter(         // custom formatter
        "analyze",
        Arc::new(MyFormatter),
    )
    .connect_vertex(project, location, token)
    .await?;

With the L1 Builder

LiveSessionBuilder::new(config)
    .dispatcher(dispatcher)
    .tool_execution_mode("search_kb", ToolExecutionMode::Background {
        formatter: None,
    })
    .connect()
    .await?;

Variants

Standard

The tool runs inline (blocking the model turn until complete).

Background

The tool runs in the background.

An optional ResultFormatter controls how acknowledgment, result, and cancellation messages are shaped. When None, the DefaultResultFormatter is used.

The scheduling field controls how the model handles async results:

• Interrupt: halts current output, immediately reports the result
• WhenIdle: waits until current output finishes before handling
• Silent: integrates the result without notifying the user

Fields

formatter: Option<Arc<dyn ResultFormatter>>

Custom formatter for background tool results, or None for the default.

scheduling: Option<FunctionResponseScheduling>

How the model should handle the async result. Defaults to WhenIdle.

Trait Implementations

impl Clone for ToolExecutionMode

fn clone(&self) -> ToolExecutionMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolExecutionMode

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

Formats the value using the given formatter.

impl Default for ToolExecutionMode

fn default() -> ToolExecutionMode

Returns the “default value” for a type.