Struct SearchCodebaseResponse 

pub struct SearchCodebaseResponse {
    pub matches: Vec<SearchMatch>,
    pub total_matches: usize,
    pub returned_count: usize,
    pub truncated: bool,
    pub file_groups: Option<Vec<SearchResultGroup>>,
    pub degraded: bool,
    pub degraded_reason: Option<String>,
    pub next_offset: Option<u32>,
}

The response for search_codebase.

Fields

matches: Vec<SearchMatch>

List of search matches.

total_matches: usize

Raw match count from ripgrep before filter_mode filtering, after ripgrep truncation.

When truncated = true, this equals max_results and ripgrep stopped searching early. When filter_mode is "comments_only" or "code_only", matches that do not pass the filter are excluded from matches but still counted here. Compare with returned_count to understand how many matches were filtered.

returned_count: usize

Number of matches actually returned in this response (after filter_mode filtering).

returned_count == matches.len(). Provided as a convenience field so agents do not need to count matches themselves.

truncated: bool

Indicates if the match list was truncated by max_results.

file_groups: Option<Vec<SearchResultGroup>>

Grouped output — populated when group_by_file: true.

Each group represents one file and contains either full matches (for unknown files) or minimal matches (for files in known_files).

degraded: bool

Whether the search response is degraded.

degraded_reason: Option<String>

Reason for degradation, if any.

next_offset: Option<u32>

When results are truncated, this field provides the offset value to use for the next page of results. Absent when not truncated.

Trait Implementations

impl Debug for SearchCodebaseResponse

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

Formats the value using the given formatter.

impl JsonSchema for SearchCodebaseResponse

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SearchCodebaseResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.