Struct WorkspaceSearchOutput 

pub struct WorkspaceSearchOutput {
    pub pattern: String,
    pub matches: Vec<SearchMatch>,
    pub truncated: bool,
    pub max_matches: usize,
}

Workspace workspace search output request or result value. Creating the value does not touch the filesystem; workspace executors document read, write, edit, or search effects.

Fields

pattern: String

Search pattern supplied by the caller. The grep executor compiles it under regex and output bounds before reading files.

matches: Vec<SearchMatch>

Collection of matches values. Ordering and membership should be treated as part of the serialized contract when relevant.

truncated: bool

Whether output was shortened by byte, item, page, archive, or parser limits.

max_matches: usize

Maximum number of matches to return. Use it to keep search output bounded for model context.

Trait Implementations

impl Clone for WorkspaceSearchOutput

fn clone(&self) -> WorkspaceSearchOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceSearchOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkspaceSearchOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorkspaceSearchOutput

impl PartialEq for WorkspaceSearchOutput

fn eq(&self, other: &WorkspaceSearchOutput) -> 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 Serialize for WorkspaceSearchOutput

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 WorkspaceSearchOutput