Struct List 

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

Lists the files under a directory, as far down as asked, honouring .gitignore (Listing::Visible, or Listing::Hidden when asked or when the glob names a hidden path): one path per line below the listed directory, and each directory deeper than the listing goes once, as dir/. Publishes what it listed (FilesListed) and, when the list was cut, OutputCut.

Fields

workspace: Arc<dyn Workspace>

Where the files are listed.

base: Option<PathBuf>

The directory a relative path is listed from; None is the workspace’s working directory.

confine: bool

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

Trait Implementations

impl Clone for List

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 List

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

Formats the value using the given formatter.

impl Default for List

fn default() -> Self

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

impl Tool for List

const NAME: &'static str = "list"

Unique registration and provider-facing name.

type Args = ListArgs

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