Skip to main content

ToolContext

Struct ToolContext 

Source
pub struct ToolContext {
    pub working_directory: String,
    pub user_id: Option<String>,
    pub metadata: HashMap<String, String>,
    pub capabilities: Option<Value>,
    pub idempotency_registry: Option<IdempotencyRegistry>,
    pub staging_backend: Option<Arc<dyn StagingBackend>>,
}
Expand description

Execution context for a tool.

Provides the working directory, optional metadata, and permission capabilities to tool implementations.

Fields§

§working_directory: String

Current working directory for resolving relative paths

§user_id: Option<String>

User ID (if authenticated)

§metadata: HashMap<String, String>

Additional context data (application-specific key-value pairs)

§capabilities: Option<Value>

Agent capabilities for permission checks (serialized as JSON value).

Consumers should serialize their concrete capability types into this field and deserialize when reading. This keeps the core crate free of capability type definitions.

§idempotency_registry: Option<IdempotencyRegistry>

Per-run idempotency registry for mutating file operations.

When Some, write/delete/edit operations derive a content-addressed key and skip re-execution if the same key has already been processed in this run. None disables idempotency tracking (useful for tests or simple single-call use cases).

§staging_backend: Option<Arc<dyn StagingBackend>>

Optional two-phase commit staging backend.

When Some, mutating file operations (write_file, edit_file, patch_file) stage their writes instead of applying them immediately. The caller is responsible for calling backend.commit() to finalize the writes, or backend.rollback() to discard them.

Staging is checked after the idempotency registry: if the same operation key is already cached, the cached result is returned without staging again.

Implementations§

Source§

impl ToolContext

Source

pub fn with_idempotency_registry(self) -> ToolContext

Attach a fresh idempotency registry to this context (builder pattern).

Source

pub fn with_staging_backend( self, backend: Arc<dyn StagingBackend>, ) -> ToolContext

Attach a staging backend for two-phase commit file writes (builder pattern).

Trait Implementations§

Source§

impl Clone for ToolContext

Source§

fn clone(&self) -> ToolContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ToolContext

Source§

fn default() -> ToolContext

Returns the “default value” for a type. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,