Struct ToolResultExtensions 

pub struct ToolResultExtensions { /* private fields */ }

Type-erased metadata a tool attaches to its structured result.

The result-side counterpart of ToolCallExtensions. A tool builds these on its ToolReturn (or directly on a ToolExecutionResult) to carry provider-specific or application-specific values — raw HTTP headers, a provider response id, retry hints — alongside the model-visible output.

These are machine-visible only: they are surfaced to hooks (via StepEvent::ToolResult), tracing, and policies, but are never serialized into the tool result the model sees. This is the same “not sent to the model” contract as Pydantic AI’s tool-return metadata and the Vercel AI SDK’s toolMetadata.

Backed by the same internal TypeMap as ToolCallExtensions, so an empty set (the common case) allocates nothing.

Example

use rig_core::tool::ToolResultExtensions;

#[derive(Clone, Debug, PartialEq)]
struct HttpStatus(u16);

let mut extensions = ToolResultExtensions::new();
extensions.insert(HttpStatus(404));
assert_eq!(extensions.get::<HttpStatus>(), Some(&HttpStatus(404)));

Implementations

impl ToolResultExtensions

pub const fn new() -> Self

Create an empty set of result extensions (allocation-free).

pub fn insert<T: Clone + WasmCompatSend + WasmCompatSync + 'static>( &mut self, val: T, ) -> Option<T>

Insert a typed value, returning the previous value of the same type if one was present.

pub fn get<T: WasmCompatSend + WasmCompatSync + 'static>(&self) -> Option<&T>

Get a reference to a value by type. Returns None if not present.

pub fn require<T: WasmCompatSend + WasmCompatSync + 'static>( &self, ) -> Result<&T, MissingExtension>

Get a reference to a value by type, returning a descriptive error naming the missing type instead of a silent None.

pub fn get_mut<T: WasmCompatSend + WasmCompatSync + 'static>( &mut self, ) -> Option<&mut T>

Get a mutable reference to a value by type. Returns None if not present.

pub fn remove<T: WasmCompatSend + WasmCompatSync + 'static>( &mut self, ) -> Option<T>

Remove a value by type, returning it if present.

pub fn contains<T: WasmCompatSend + WasmCompatSync + 'static>(&self) -> bool

Check if a value of the given type is present.

pub fn len(&self) -> usize

Number of values currently stored.

pub fn is_empty(&self) -> bool

Whether no values are stored.

Trait Implementations

impl Clone for ToolResultExtensions

fn clone(&self) -> ToolResultExtensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResultExtensions

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

Formats the value using the given formatter.

impl Default for ToolResultExtensions

fn default() -> ToolResultExtensions

Returns the “default value” for a type.