Struct ReadTool 

pub struct ReadTool<const LINE_NUMBERS: bool = true> { /* private fields */ }

Tool for reading file contents with optional line numbers.

Restricts access to configured allowed directories.

Implementations

impl<const LINE_NUMBERS: bool> ReadTool<LINE_NUMBERS>

pub fn new(resolver: AllowedPathResolver) -> Self

Creates a new read tool with a shared resolver.

Use a single AllowedPathResolver across all allowed tools to ensure consistent path access:

use llm_coding_tools_core::path::AllowedPathResolver;
use llm_coding_tools_rig::allowed::{ReadTool, WriteTool, EditTool};
use std::path::PathBuf;

let resolver = AllowedPathResolver::new(vec![
    std::env::current_dir().unwrap(),
    PathBuf::from("/tmp"),
]).unwrap();

let read: ReadTool<true> = ReadTool::new(resolver.clone());
let write = WriteTool::new(resolver.clone());
let edit = EditTool::new(resolver);

Trait Implementations

impl<const LINE_NUMBERS: bool> Clone for ReadTool<LINE_NUMBERS>

fn clone(&self) -> ReadTool<LINE_NUMBERS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LINE_NUMBERS: bool> Debug for ReadTool<LINE_NUMBERS>

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

Formats the value using the given formatter.

impl<const LINE_NUMBERS: bool> Tool for ReadTool<LINE_NUMBERS>

const NAME: &'static str = tool_names::READ

The name of the tool. This name should be unique.

type Error = ToolError

The error type of the tool.

type Args = ReadArgs

The arguments type of the tool.

type Output = ToolOutput

The output type of the tool.

async fn definition(&self, _prompt: String) -> ToolDefinition

A method returning the tool definition. The user prompt can be used to tailor the definition to the specific use case.

async fn call(&self, args: Self::Args) -> Result<Self::Output, Self::Error>

The tool execution method. Both the arguments and return value are a String since these values are meant to be the output and input of LLM models (respectively)

fn name(&self) -> String

A method returning the name of the tool.

impl<const LINE_NUMBERS: bool> ToolContext for ReadTool<LINE_NUMBERS>

const NAME: &'static str = tool_names::READ

Tool name used for section headers in generated system prompt.

fn context(&self) -> &'static str

Returns the tool’s context string for system prompt generation.