Skip to main content

ScopedTool

Struct ScopedTool 

Source
pub struct ScopedTool<T: Tool> { /* private fields */ }
Expand description

A tool wrapper that enforces scope requirements before execution.

Trait Implementations§

Source§

impl<T: Tool + Send + Sync> Tool for ScopedTool<T>

Source§

fn name(&self) -> &str

Source§

fn description(&self) -> &str

Source§

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.
Source§

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.
Source§

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

Source§

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

Source§

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool. Read more
Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for ScopedTool<T>
where T: Freeze,

§

impl<T> !RefUnwindSafe for ScopedTool<T>

§

impl<T> Send for ScopedTool<T>

§

impl<T> Sync for ScopedTool<T>

§

impl<T> Unpin for ScopedTool<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for ScopedTool<T>
where T: UnsafeUnpin,

§

impl<T> !UnwindSafe for ScopedTool<T>

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> 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> ScopeToolExt for T
where T: Tool,

Source§

fn with_scope_guard( self, resolver: impl ScopeResolver + 'static, ) -> ScopedTool<Self>

Wrap this tool with scope enforcement using the given resolver.
Source§

impl<T> ToolExt for T
where T: Tool,

Source§

fn with_access_control(self, ac: Arc<AccessControl>) -> ProtectedTool<Self>

Wrap this tool with access control.
Source§

fn with_access_control_and_audit( self, ac: Arc<AccessControl>, audit: Arc<dyn AuditSink>, ) -> ProtectedTool<Self>

Wrap this tool with access control and audit logging.
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