Struct ScopeSearch 

pub struct ScopeSearch {
    pub query: SearchQuery,
    pub total: u32,
    pub returned: u32,
    pub offset: u32,
    pub truncated: bool,
    pub next_offset: Option<u32>,
    pub documents: Vec<ScopedSearchDocument>,
}

Globally paginated search over a resolved document scope.

Fields

query: SearchQuery

Normalized search configuration.

total: u32

Matching line groups across all documents before pagination.

returned: u32

Matching line groups present in this response.

offset: u32

Applied global zero-based offset.

truncated: bool

Whether additional matching line groups remain.

next_offset: Option<u32>

Global offset for the next page.

documents: Vec<ScopedSearchDocument>

Non-empty document groups in scope order.

Trait Implementations

impl Clone for ScopeSearch

fn clone(&self) -> ScopeSearch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeSearch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopeSearch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScopeSearch

impl JsonSchema for ScopeSearch

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 ScopeSearch

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScopeSearch

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 ScopeSearch