Struct GetUserChoiceTool 

pub struct GetUserChoiceTool;

Tool that presents a list of options to the user and waits for selection.

This is a long-running tool — the model calls it to present choices, and execution pauses until the user makes a selection.

Implementations

impl GetUserChoiceTool

pub fn new() -> Self

Create a new get user choice tool.

Trait Implementations

impl Clone for GetUserChoiceTool

fn clone(&self) -> GetUserChoiceTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetUserChoiceTool

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

Formats the value using the given formatter.

impl Default for GetUserChoiceTool

fn default() -> GetUserChoiceTool

Returns the “default value” for a type.

impl ToolFunction for GetUserChoiceTool

fn name(&self) -> &str

The unique name of this tool.

fn description(&self) -> &str

Human-readable description of what this tool does.

fn parameters(&self) -> Option<Value>

JSON Schema for the tool’s input parameters, or None if parameterless.

fn call<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool with the given arguments and return the result.

fn requires_confirmation(&self) -> bool

Whether this tool must be confirmed before it runs. Defaults to false.

fn confirmation_message(&self) -> Option<&str>

Optional hint shown when confirmation is requested.