Struct SearchResultEnvelope 

pub struct SearchResultEnvelope<'a> {
    pub total: usize,
    pub returned: usize,
    pub offset: usize,
    pub total_tokens: usize,
    pub hits: Vec<SearchHitEnvelope<'a>>,
    pub facets: Option<&'a Facets>,
    pub warnings: &'a Vec<WarningHint>,
}

Envelope for a full SearchResult: _-prefixed engine-emitted counters at the top level, facets as a structured object (not a markdown blob), and the full per-hit shape (score, score_breakdown, matched_terms, expansion) inherited verbatim from SearchHit so the structured envelope is the branching surface — agents reading structured_content don’t have to parse the text channel’s rendered prose to recover scores or score components. CLI --json and MCP structured_content share this shape.

Fields

total: usize

returned: usize

offset: usize

total_tokens: usize

Sum of estimated tokens across all matching entities (pre-pagination). Mirrors ListResultEnvelope.total_tokens so the field has consistent meaning across both surfaces — migration cost for agents is zero.

hits: Vec<SearchHitEnvelope<'a>>

facets: Option<&'a Facets>

Faceted counts over the unpaginated hit set. Skipped on the wire when the engine produced no facets (rare; the unified engine always populates an empty Facets::default() for shape stability).

warnings: &'a Vec<WarningHint>

Trait Implementations

impl<'a> Serialize for SearchResultEnvelope<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.