Struct Read 

pub struct Read {
    pub workspace: Arc<dyn Workspace>,
    pub base: Option<PathBuf>,
    pub confine: bool,
    pub seen: Seen,
}

Reads a text file’s lines as they are. Publishes the file it read (FilesRead), by its resolved path, with the hash of the bytes it read and the lines it showed, and, when lines after those were left out, OutputCut.

Fields

workspace: Arc<dyn Workspace>

Where the file is read.

base: Option<PathBuf>

The directory a relative path is read from; None is the workspace’s working directory.

confine: bool

Whether a path that resolves outside base is refused, before anything is read.

seen: Seen

Where each file read is noted, for an Edit given the same to tell whether a file changed since.

Trait Implementations

impl Clone for Read

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Read

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

Formats the value using the given formatter.

impl Default for Read

fn default() -> Self

Reads this machine’s files, from this process’s working directory.

impl Tool for Read

const NAME: &'static str = "read"

Unique registration and provider-facing name.

type Args = ReadArgs

Typed JSON arguments.

type Output = String

Output convertible into Rig’s canonical model presentation.

type Error = ToolExecutionError

Typed error returned by direct calls to this tool.

fn description(&self) -> String

Model-facing description.

fn parameters(&self) -> Value

JSON Schema for arguments.

fn annotations(&self) -> ToolAnnotations

What calling the tool does to the world, for the host’s policies (approval, plan mode, which calls run side by side). Nothing is stated by default, which reads as the protocol’s defaults (ToolAnnotations).

fn footprint(&self, args: &ReadArgs) -> Touches

What a call with args may read and change, so a host runs the calls of one reply that touch different things side by side. The default reads it from the annotations: a read-only tool reads anything, any other writes anything.

async fn call( &self, context: &mut ToolContext, args: ReadArgs, ) -> Result<String, ToolExecutionError>

Execute the tool.

fn map_error(&self, error: Self::Error) -> ToolExecutionError

Normalize a typed author-facing error for runtime policy and telemetry.