Struct Edit 

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

Replaces text in a file. Publishes the file it changed (FilesChanged): its resolved path, and the whole diff.

Fields

workspace: Arc<dyn Workspace>

Where the file is edited.

base: Option<PathBuf>

The directory a relative path is edited in; None is the workspace’s working directory.

confine: bool

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

seen: Seen

The files Read showed and edits left, shared with it: an old_text not found asks for a new read only of a file that changed since, and an edit of a file seen whole is made from that text, in one write_if.

Trait Implementations

impl Clone for Edit

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 Edit

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

Formats the value using the given formatter.

impl Default for Edit

fn default() -> Self

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

impl Tool for Edit

const NAME: &'static str = "edit"

Unique registration and provider-facing name.

type Args = EditArgs

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: &EditArgs) -> 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: EditArgs, ) -> 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.