Enum Action 

pub enum Action {
    Read {
        path: String,
        lines: Lines,
    },
    List {
        path: String,
        depth: Option<i64>,
    },
    Search {
        pattern: String,
        path: String,
        glob: Option<String>,
        ignore_case: bool,
    },
    Edit {
        path: String,
        old_text: String,
        new_text: String,
    },
    Run {
        command: String,
    },
}

One action the model asked for.

Variants

Read

Read a text file, all of it or one range of lines.

Fields

path: String

The file, relative to the workspace root.

lines: Lines

Which lines of it to show; neither number given is its top, as it was before.

List

List a folder; an empty path or . is the root.

Fields

path: String

The folder, relative to the workspace root.

depth: Option<i64>

How many levels to show, 1 for a list of names and more for a tree with sizes.

Search

Find a piece of text in the files under a folder.

Fields

pattern: String

The text to find, matched as it is written unless the case is ignored.

path: String

Where to start; an empty path is the root.

glob: Option<String>

A name pattern a file’s path must match; none looks at every file.

ignore_case: bool

Whether the case of the pattern counts.

Edit

Replace one exact piece of text in a file, or create a new file.

Fields

path: String

The file, relative to the workspace root.

old_text: String

The text to replace; it must occur exactly once. Empty to create a new file.

new_text: String

The text that takes its place.

Run

Run a shell command in the workspace root.

Fields

command: String

The command, given to sh -c.

Implementations

impl Action

pub fn definitions() -> Value

The five tools in Anthropic tool-use form: the JSON array for the request’s tools field, each with a name, a description and an input_schema. It is the model’s manual, so every optional field carries a short example of a call that uses it.

pub fn from_call(name: &str, input: &Value) -> Result<Self, String>

Reads a tool call. An unknown tool or a bad input gives a sentence for the model.

Errors

When name is not one of the five tools, or input is not an object with the fields the tool needs: text as a string, a line or a depth as a whole number, a flag as true or false. Whether a range fits the file it names is left to the action, which reads the file.

pub fn needs_approval(&self) -> bool

Whether the person must approve the action first: editing and running do, reading does not.

pub fn kind(&self) -> ActionKind

Which action this is.

pub fn subject(&self) -> &str

What the action is about: the path for reading, listing and editing, the pattern for a search and the command for running. The new fields narrow an action; they are not what the action is about, so the person’s line stays the same.

pub fn summary(&self) -> String

One short untranslated line for the transcript, such as read src/main.rs or run cargo test. An application that translates builds its own line from Self::kind and Self::subject.

Trait Implementations

impl Clone for Action

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 Action

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

Formats the value using the given formatter.

impl Eq for Action

impl PartialEq for Action

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Action