Enum ApprovalDecision 

#[non_exhaustive]
pub enum ApprovalDecision {
    Approve,
    ApproveWithInput(Value),
    Substitute(Value),
    Deny(String),
    Stop(String),
}

Available on crate feature async only.

Verdict from a ToolApprover for a single tool_use invocation.

Approvers are consulted by crate::Client::run before each tool dispatch, so users can gate side-effecting tools behind an interactive confirmation, a policy check, an input rewriter, or a static allowlist.

Variants (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.

Approve

Proceed with the tool dispatch unchanged.

ApproveWithInput(Value)

Proceed, but substitute a different input (the model’s original payload is discarded). Useful for sanitizing arguments before the tool runs (path scrubbing, scope clamping, etc.).

Substitute(Value)

Skip the tool dispatch entirely and return value as the tool_result content (with no is_error flag). Useful for stubbing tools in tests or short-circuiting expensive calls when the answer is already known.

Deny(String)

Skip the tool dispatch. The supplied reason is returned to the model as the tool_result content (with is_error = true) so the model can choose how to recover.

Stop(String)

Abort the entire agent loop. Surfaces as crate::Error::ToolApprovalStopped from Client::run.

Trait Implementations

impl Clone for ApprovalDecision

fn clone(&self) -> ApprovalDecision

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApprovalDecision

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

Formats the value using the given formatter.