pub struct ReadFileTool { /* private fields */ }Expand description
Tool that reads files from the filesystem.
Implementations§
Source§impl ReadFileTool
impl ReadFileTool
Sourcepub fn new(permission_registry: Arc<PermissionRegistry>) -> ReadFileTool
pub fn new(permission_registry: Arc<PermissionRegistry>) -> ReadFileTool
Create a new ReadFileTool instance.
Trait Implementations§
Source§impl Executable for ReadFileTool
impl Executable for ReadFileTool
Source§fn description(&self) -> &str
fn description(&self) -> &str
Get the tool description.
Source§fn input_schema(&self) -> &str
fn input_schema(&self) -> &str
Get the input schema as JSON string.
Source§fn execute(
&self,
context: ToolContext,
input: HashMap<String, Value>,
) -> Pin<Box<dyn Future<Output = Result<String, String>> + Send>>
fn execute( &self, context: ToolContext, input: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<String, String>> + Send>>
Execute the tool with given input.
Source§fn display_config(&self) -> DisplayConfig
fn display_config(&self) -> DisplayConfig
Get display configuration for UI rendering.
Source§fn compact_summary(
&self,
input: &HashMap<String, Value>,
result: &str,
) -> String
fn compact_summary( &self, input: &HashMap<String, Value>, result: &str, ) -> String
Generate compact summary for context compaction.
Source§fn required_permissions(
&self,
context: &ToolContext,
input: &HashMap<String, Value>,
) -> Option<Vec<PermissionRequest>>
fn required_permissions( &self, context: &ToolContext, input: &HashMap<String, Value>, ) -> Option<Vec<PermissionRequest>>
Return the permissions required to execute this tool with the given input. Read more
Source§fn to_definition(&self) -> ToolDefinition
fn to_definition(&self) -> ToolDefinition
Convert to LLM tool definition.
Source§fn to_llm_tool(&self) -> Tool
fn to_llm_tool(&self) -> Tool
Convert to LLMTool for provider APIs.
Source§fn handles_own_permissions(&self) -> bool
fn handles_own_permissions(&self) -> bool
Whether this tool handles its own permission flow internally. Read more
Auto Trait Implementations§
impl Freeze for ReadFileTool
impl !RefUnwindSafe for ReadFileTool
impl Send for ReadFileTool
impl Sync for ReadFileTool
impl Unpin for ReadFileTool
impl !UnwindSafe for ReadFileTool
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more