Enum BuiltinTool 

#[non_exhaustive]
pub enum BuiltinTool {
    ListDirectory,
    SearchDirectory,
    FindFile,
    ViewFile,
    CreateFile,
    EditFile,
    DeleteFile,
    RenameFile,
    RunCommand,
    AskQuestion,
    StartSubagent,
    GenerateImage,
    CallAgent,
    CompileRustlite,
    RunCartridge,
    RenderHtml,
    ConfigureAgent,
    CurrentTime,
    Finish,
}

Identifiers for the SDK’s built-in tools.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ListDirectory

List a directory’s contents.

SearchDirectory

Regex search within files.

FindFile

Find files by glob pattern.

ViewFile

Read a file’s contents.

CreateFile

Create a new file.

EditFile

Apply edits to an existing file.

DeleteFile

Delete a file or directory.

RenameFile

Rename or move a file.

RunCommand

Execute a shell command.

AskQuestion

Prompt the user with a question.

StartSubagent

Spawn a sub-agent.

GenerateImage

Generate an image via the image model.

CallAgent

Call another agent via inter-agent RPC.

CompileRustlite

Compile and run a rustlite program.

RunCartridge

Compile a rustlite cartridge and run it on the visual display.

RenderHtml

Render an HTML document onto the visual display (framebuffer).

ConfigureAgent

Read/update this agent’s own config manifest (system prompt + tool allowlist), or reset it to defaults.

CurrentTime

Get the current host wall-clock time (UNIX + ISO-8601 UTC).

Finish

Signal that the agent’s turn is complete.

Implementations

impl BuiltinTool

pub const ALL: &'static [BuiltinTool]

Every built-in tool variant.

pub const READ_ONLY: &'static [BuiltinTool]

Tools that only read state (no side effects).

pub const FILE_TOOLS: &'static [BuiltinTool]

Tools that operate on individual files.

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

The snake_case wire name the model uses to invoke this tool.

Trait Implementations

impl Clone for BuiltinTool

fn clone(&self) -> BuiltinTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BuiltinTool

impl Debug for BuiltinTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuiltinTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BuiltinTool

impl Hash for BuiltinTool

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 BuiltinTool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BuiltinTool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuiltinTool