Struct ToolDisplayHook 

pub struct ToolDisplayHook { /* private fields */ }

A hook that shows Claude Code style tool execution

Implementations

impl ToolDisplayHook

pub fn new() -> Self

pub fn state(&self) -> Arc<Mutex<DisplayState>>

Get the shared state for external access

pub async fn get_usage(&self) -> AccumulatedUsage

Get accumulated usage (blocks on lock)

pub async fn reset_usage(&self)

Reset usage counter (e.g., at start of a new request batch)

pub async fn set_progress_state(&self, progress: Arc<ProgressState>)

Set the progress indicator state for real-time token display

pub async fn clear_progress_state(&self)

Clear the progress state

pub async fn cancel(&self)

Trigger cancellation of the current request. This will cause rig to stop after the current tool/response completes.

pub async fn can_cancel(&self) -> bool

Check if cancellation is possible (a cancel signal is stored)

Trait Implementations

impl Clone for ToolDisplayHook

fn clone(&self) -> ToolDisplayHook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ToolDisplayHook

fn default() -> Self

Returns the “default value” for a type.

impl<M> PromptHook<M> for ToolDisplayHook

where M: CompletionModel,

fn on_tool_call( &self, tool_name: &str, _tool_call_id: Option<String>, args: &str, cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called before a tool is invoked.

fn on_tool_result( &self, tool_name: &str, _tool_call_id: Option<String>, args: &str, result: &str, _cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called after a tool is invoked (and a result has been returned).

fn on_completion_response( &self, _prompt: &Message, response: &CompletionResponse<M::Response>, cancel: CancelSignal, ) -> impl Future<Output = ()> + Send

Called after the prompt is sent to the model and a response is received.

fn on_completion_call( &self, prompt: &Message, history: &[Message], cancel_sig: CancelSignal, ) -> impl Future<Output = ()> + WasmCompatSend

Called before the prompt is sent to the model