Struct Search 

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

Searches file contents with a regular expression, honouring .gitignore, or lists the files with a match, or every file. Shows each path as read takes it from the same base: below the base when the searched path is relative or not given, absolute when it is absolute. Publishes what it found (SearchHits) and the files it found matches in (FilesRead), by their resolved paths.

Fields

workspace: Arc<dyn Workspace>

Where the files are searched.

base: Option<PathBuf>

The directory searched, and a relative path is searched from; None is the workspace’s working directory. Hits of a relative path are shown, and published, by their paths below it.

confine: bool

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

Trait Implementations

impl Clone for Search

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 Search

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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Self

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

impl Tool for Search

const NAME: &'static str = "search"

Unique registration and provider-facing name.

type Args = SearchArgs

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