Struct AskUserTool 

pub struct AskUserTool { /* private fields */ }

Tool for asking the user a question during agent execution.

When a ask_tx channel is set (TUI mode), the tool blocks until the user answers. When None (headless/pipe mode), the tool formats the question and returns immediately.

Implementations

impl AskUserTool

pub fn new() -> Self

Create an ask_user tool without a channel (headless mode).

pub fn with_ask_tx(self, tx: AskUserSender) -> Self

Attach an ask-user channel for interactive (TUI) mode.

Trait Implementations

impl BaseTool for AskUserTool

fn name(&self) -> &str

Unique tool name used for dispatch.

fn description(&self) -> &str

Human-readable description shown to the LLM.

fn parameter_schema(&self) -> Value

JSON Schema describing the tool’s parameters.

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, args: HashMap<String, Value>, _ctx: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>

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

Execute the tool with the given arguments and context.

fn format_validation_error(&self, errors: &[ValidationError]) -> Option<String>

Format a validation error into a tool-specific, LLM-friendly message.

fn display_meta(&self) -> Option<ToolDisplayMeta>

Return TUI display metadata for this tool.

impl Debug for AskUserTool

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

Formats the value using the given formatter.

impl Default for AskUserTool

fn default() -> Self

Returns the “default value” for a type.