Enum QueryView 

pub enum QueryView {
    Full {},
    Outline {
        entries: EntryProjection,
        root: Option<NodeSelector>,
    },
    Excerpt {
        selectors: Vec<NodeSelector>,
    },
    Explain {
        entry: String,
    },
    Search {
        pattern: String,
        syntax: SearchSyntax,
        case: SearchCase,
        scope: SearchScope,
        word: bool,
        context_lines: u16,
        limit: u32,
        offset: u32,
    },
}

Projection requested after loading one complete structured document.

Variants

Full

Return the complete structured query bundle.

Outline

Return a navigable structural projection.

Fields

entries: EntryProjection

Semantic entry material included beneath structural nodes.

root: Option<NodeSelector>

Optional section or entry used as the outline root.

Excerpt

Return content selected by one or more node paths, IDs, or aliases.

Fields

selectors: Vec<NodeSelector>

Ordered selectors resolved by the engine.

Explain

Resolve exactly one semantic entry and return its complete description.

Fields

entry: String

Exact or normalized semantic entry name.

Search

Search visible document content with bounded pagination.

Fields

pattern: String

Literal or regular-expression search pattern.

syntax: SearchSyntax

Pattern language.

case: SearchCase

Case-matching policy.

scope: SearchScope

Semantic content included in the search.

word: bool

Require matches to be bounded by word boundaries.

context_lines: u16

Neighboring rendered lines included around each match.

limit: u32

Maximum number of matches returned.

offset: u32

Number of matching results skipped before collection.

Trait Implementations

impl Clone for QueryView

fn clone(&self) -> QueryView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryView

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryView

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for QueryView

impl JsonSchema for QueryView

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 QueryView

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QueryView

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 QueryView