Skip to main content

ToolRenderContext

Struct ToolRenderContext 

Source
pub struct ToolRenderContext {
Show 17 fields pub expanded: bool, pub args_complete: bool, pub is_partial: bool, pub is_error: bool, pub tool_call_id: String, pub execution_started: bool, pub cwd: String, pub duration_secs: Option<f64>, pub exit_code: Option<i32>, pub cancelled: bool, pub was_truncated: bool, pub full_output_path: Option<String>, pub file_path: Option<String>, pub expand_key: String, pub details: Option<Value>, pub state: Rc<RefCell<Value>>, pub invalidate: Option<UnboundedSender<()>>,
}
Expand description

Context passed to ToolRenderer methods (matching pi’s ToolRenderContext). Carries all metadata about the tool execution that renderers may need.

Fields§

§expanded: bool§args_complete: bool§is_partial: bool§is_error: bool§tool_call_id: String

Unique id for this tool execution (pi’s toolCallId).

§execution_started: bool

Whether the tool execution has started (pi’s executionStarted).

§cwd: String

Working directory for path resolution.

§duration_secs: Option<f64>

Duration in seconds (bash).

§exit_code: Option<i32>

Exit code (bash).

§cancelled: bool

Whether execution was cancelled (bash).

§was_truncated: bool

Whether output was truncated (bash/read).

§full_output_path: Option<String>

Path to full output file (bash).

§file_path: Option<String>

File path for syntax highlighting (read).

§expand_key: String

Keybinding hint for the expand action, e.g. “C-O”.

§details: Option<Value>

Structured rendering details from the tool execution (pi-compatible). Set by tool renderers for preview/actual diff data. Not sent to the LLM.

§state: Rc<RefCell<Value>>

Shared mutable state per tool execution (pi’s context.state). Initialized as an empty JSON object {}. Renderers can mutate it across renderCall/renderResult invocations for the same tool call.

§invalidate: Option<UnboundedSender<()>>

Callback for renderers to request re-render (e.g. after async preview computation). Pi-compatible: context.invalidate() in renderCall/renderResult. Cloned from the original at context construction time. Uses a channel sender internally to bridge from async to UI thread.

Trait Implementations§

Source§

impl Clone for ToolRenderContext

Source§

fn clone(&self) -> ToolRenderContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolRenderContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more