Enum Tool 

pub enum Tool {
    Read,
    Write,
    Edit,
    Bash,
    Glob,
    Grep,
    Task,
    WebFetch,
    WebSearch,
    NotebookEdit,
    AskUserQuestion,
    TodoWrite,
    KillShell,
    TaskOutput,
    Skill,
}

Canonical tool names as an enum for type safety.

These match the actual tool names emitted by Claude Code in JSONL output. Using an enum provides compile-time checking and prevents typos.

Example

use aptitude::Tool;

let tool = Tool::Read;
assert_eq!(tool.as_str(), "Read");

Variants

Read

Read a file

Write

Write a file

Edit

Edit a file

Bash

Execute a bash command

Glob

Search for files using glob patterns

Grep

Search file contents using grep/regex

Task

Launch a subagent task

WebFetch

Fetch content from a URL

WebSearch

Search the web

NotebookEdit

Edit a Jupyter notebook cell

AskUserQuestion

Ask the user a question

TodoWrite

Write to the todo list

KillShell

Kill a background shell

TaskOutput

Get output from a background task

Skill

Execute a skill

Implementations

impl Tool

pub fn as_str(&self) -> &'static str

Get the canonical string name (matches JSONL output).

Example

use aptitude::Tool;

assert_eq!(Tool::Read.as_str(), "Read");
assert_eq!(Tool::Bash.as_str(), "Bash");

pub fn all() -> &'static [Tool]

Get all known tool variants.

Useful for generating documentation or autocomplete suggestions.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Tool

impl Debug for Tool

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

Formats the value using the given formatter.

impl Display for Tool

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

Formats the value using the given formatter.

impl Eq for Tool

impl Hash for Tool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Tool

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Tool