Skip to main content

ToolDecision

Enum ToolDecision 

Source
#[non_exhaustive]
pub enum ToolDecision { Continue, Skip { reason: String, }, Terminate { reason: String, }, }
Expand description

Decision returned from ChatMiddleware::on_before_tool_call to optionally bypass or abort a tool invocation.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Continue

Default: execute the tool.

§

Skip

Skip execution. The engine synthesizes an is_error: true crate::ToolResultContent carrying reason and feeds it back to the model so the loop can continue. Use when a single tool call should be denied (rate limit, policy violation) but the run as a whole should keep going.

Fields

§reason: String

Human-readable reason; surfaces in the synthesized error tool_result the model receives.

§

Terminate

Abort the run before executing this tool. The engine surfaces the reason as crate::FinishReason::Aborted(reason) and fires ChatMiddleware::on_run_finished; partial tool results from earlier tool calls in the same step are preserved in new_messages.

Fields

§reason: String

Human-readable reason; threaded through FinishReason::Aborted.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.