Struct GrepOutput 

pub struct GrepOutput {
    pub matches: Vec<GrepMatchEntry>,
    pub total_matches: u32,
    pub files_with_matches: u32,
    pub files_searched: u32,
    pub file_limit_reached: bool,
    pub per_file_limit_reached: bool,
    pub note: Option<String>,
    pub useless: Option<bool>,
    pub files: Vec<GrepFileEntry>,
    pub timed_out: Option<bool>,
}

Result returned by the grep tool.

Fields

matches: Vec<GrepMatchEntry>

All matches found, ordered by file path. Bounded by the file window and per-file caps described on the tool; page further files with skip.

total_matches: u32

Total number of matches across all files (a lower bound when caps trimmed the fetched matches).

files_with_matches: u32

Number of files that contained at least one match.

files_searched: u32

Number of files searched.

file_limit_reached: bool

true when more files matched than the shown window — page with skip.

per_file_limit_reached: bool

true when at least one file had more matches than shown (capped to keep a single hot file from crowding out diverse hits).

note: Option<String>

Human-readable hint: a pagination instruction when the file window was hit, or a no-match notice ("No matches found" / "No more results …").

useless: Option<bool>

true when no matches were selected. Such a result carries no new information — adjust the pattern or scope instead of blindly retrying.

files: Vec<GrepFileEntry>

Hashline anchors for shown files, in encounter order. Bounded to a small window of files (whole-file tags require reading each file); files beyond the window surface plain, headerless output.

timed_out: Option<bool>

true when the search was cut short by the timeout; matches holds the partial results found up to that point. An empty matches with this flag is an INCOMPLETE search, not proof of absence.

Trait Implementations

impl Serialize for GrepOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.