Struct CommitGuard 

pub struct CommitGuard { /* private fields */ }

A tool wrapped with idempotency and compensation. See the module docs.

Implementations

impl CommitGuard

pub fn new(inner: Arc<dyn ToolFunction>, state: State) -> Self

Guard inner, remembering results in state.

pub fn idempotency_key(self, template: impl Into<String>) -> Self

Deduplicate calls by this key template. {name} takes the call’s argument name, else the state value at name. A call where any placeholder has no value is not deduplicated (and says so in the log), so an incomplete key never merges two different commits.

pub fn compensate_with(self, tool: Arc<dyn ToolFunction>) -> Self

Run tool with the same arguments when the guarded tool fails.

Trait Implementations

impl ToolFunction for CommitGuard

fn name(&self) -> &str

The unique name of this tool.

fn description(&self) -> &str

Human-readable description of what this tool does.

fn parameters(&self) -> Option<Value>

JSON Schema for the tool’s input parameters, or None if parameterless.

fn requires_confirmation(&self) -> bool

Whether this tool must be confirmed before it runs. Defaults to false.

fn confirmation_message(&self) -> Option<&str>

Optional hint shown when confirmation is requested.

fn call<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool with the given arguments and return the result.

fn call_with_context<'life0, 'async_trait>( &'life0 self, args: Value, ctx: ToolContext, ) -> Pin<Box<dyn Future<Output = Result<Value, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool knowing the session it runs in: its State, the call’s id, and a cancellation token (see ToolContext).