Struct QueryResponse 

pub struct QueryResponse {

    pub ai_instruction: Option<String>,
    pub status: IndexStatus,
    pub can_trust_results: bool,
    pub warning: Option<IndexWarning>,
    pub pagination: PaginationInfo,
    pub results: Vec<FileGroupedResult>,
    pub substring_hint_count: Option<usize>,
    pub warnings: Vec<String>,
    pub hint: Option<String>,
    pub excluded_reason: Option<ExcludedReason>,
    pub excluded_by_default: Option<usize>,
    pub file_count: Option<usize>,
    pub timings: Option<QueryTimings>,
}

Query response with results and index status

Fields

ai_instruction: Option<String>

AI-optimized instruction for how to handle these results Only present when –ai flag is used or in MCP mode Provides guidance to AI agents on response format and next actions

status: IndexStatus

Status of the index (fresh or stale)

can_trust_results: bool

Whether the results can be trusted

warning: Option<IndexWarning>

Warning information (only present if stale)

pagination: PaginationInfo

Pagination information

results: Vec<FileGroupedResult>

File-grouped search results Results are always grouped by file path, with dependencies populated when –dependencies flag is used

substring_hint_count: Option<usize>

For a whole-identifier search that found nothing: how many candidate lines contain the pattern as a substring. Lets the caller explain a zero without running a second search. Absent whenever there were results, or when the search was not a whole-identifier one.

warnings: Vec<String>

Things the engine did to the query that the caller should know about.

Today this is one message at most: a whole-identifier pattern containing brackets was escaped and run as a regex (see query::prepare_literal_pattern). Every surface — CLI, MCP, HTTP — carries it, so a rewrite is never silent on any of them.

hint: Option<String>

For a whole-identifier search that found nothing while substring matches exist: a ready-to-show sentence naming the count and the switch that shows them. Absent whenever there were results, or when the search was not a whole-identifier one.

excluded_reason: Option<ExcludedReason>

Machine-readable cause behind hint: hidden (the filter names a dot-directory), not_indexed (the file filter names a path the index does not hold), lock_or_generated, whole_identifier. Absent when no rule applies, so a harness can branch without parsing prose.

excluded_by_default: Option<usize>

For a search that found nothing: how many candidate files were lock or generated files, which every search leaves out unless include_locks / include_generated (or lang) asks for them. The hint says so too.

file_count: Option<usize>

Count-only searches: the number of files with at least one match. results is empty in that mode, so this is the only place the file count lives.

timings: Option<QueryTimings>

Per-phase timings, only when requested.

Trait Implementations

impl Clone for QueryResponse

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 QueryResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.