Skip to main content

ReadTool

bamboo_tools::tools::read

Struct ReadTool

pub struct ReadTool;

Implementations§

impl ReadTool

pub fn new() -> Self

Trait Implementations§

impl Default for ReadTool

fn default() -> Self

Returns the “default value” for a type. Read more

impl Tool for ReadTool

fn name(&self) -> &str

fn description(&self) -> &str

Human-readable tool description for LLM.

fn classify(&self, _args: &Value) -> ToolClass

Per-call scheduling + permission-gating class (args-aware). Folds the former mutability/call_mutability/concurrency_safe/ call_concurrency_safe hooks into one value. Defaults to the conservative ToolClass::MUTATING_SERIAL (mutating, serial, not promotable).

fn parameters_schema(&self) -> Value

JSON Schema for tool parameters.

fn invoke<'life0, 'async_trait>( &'life0 self, args: Value, ctx: ToolCtx, ) -> Pin<Box<dyn Future<Output = Result<ToolOutcome, ToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The sole execution entry: returns the call’s per-call ToolOutcome (Completed / Running / NeedsHuman), or a ToolError for infrastructure / argument failures (preserved from the former execute). Read more

fn to_schema(&self) -> ToolSchema

Convert tool to LLM-compatible schema. Read more

Auto Trait Implementations§

impl Freeze for ReadTool

impl RefUnwindSafe for ReadTool

impl Send for ReadTool

impl Sync for ReadTool

impl Unpin for ReadTool

impl UnsafeUnpin for ReadTool

impl UnwindSafe for ReadTool

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

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

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more