Struct QuerySearch 

pub struct QuerySearch {
    pub schema: SearchSchema,
    pub label: String,
    pub source: Option<DocumentSource>,
    pub meta: Option<DocumentMeta>,
    pub query: SearchQuery,
    pub render: SearchRender,
    pub total: u32,
    pub returned: u32,
    pub offset: u32,
    pub truncated: bool,
    pub next_offset: Option<u32>,
    pub matches: Vec<SearchMatch>,
}

Complete, paginatable search result returned to agents and scripts.

Fields

schema: SearchSchema

Exact response schema discriminator.

label: String

Human-readable selected-document label.

source: Option<DocumentSource>

Authoritative document source, when one was loaded.

meta: Option<DocumentMeta>

Document metadata, when one was loaded.

query: SearchQuery

Normalized query applied by the engine.

render: SearchRender

Coordinate-space description shared by all matches.

total: u32

Total matches before pagination.

returned: u32

Number of matches present in Self::matches.

offset: u32

Applied zero-based match offset.

truncated: bool

Whether additional matches remain.

next_offset: Option<u32>

Offset for the next page, when one exists.

matches: Vec<SearchMatch>

Matching occurrences in render order.

Trait Implementations

impl Clone for QuerySearch

fn clone(&self) -> QuerySearch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuerySearch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QuerySearch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for QuerySearch

impl JsonSchema for QuerySearch

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 PartialEq for QuerySearch

fn eq(&self, other: &QuerySearch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for QuerySearch

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 QuerySearch