Struct SearchMatch 

pub struct SearchMatch {
    pub ordinal: u32,
    pub node: SearchNode,
    pub section: Option<SearchSectionReference>,
    pub matched_text: String,
    pub markdown: SearchMarkdownRange,
    pub source: Option<SourceSpan>,
    pub preview: String,
    pub context: Vec<SearchContextLine>,
}

One exact occurrence and both of its structural and rendered locations.

Fields

ordinal: u32

One-based occurrence number in the unpaginated result set.

node: SearchNode

Nearest structurally addressable node.

section: Option<SearchSectionReference>

Containing document section, when applicable.

matched_text: String

Exact text consumed by the matcher.

markdown: SearchMarkdownRange

Location in the deterministic full Markdown render.

source: Option<SourceSpan>

Original-source location, when the parser retained one.

preview: String

Compact single-string presentation of the match.

context: Vec<SearchContextLine>

Optional rendered lines surrounding the match.

Trait Implementations

impl Clone for SearchMatch

fn clone(&self) -> SearchMatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchMatch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchMatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SearchMatch

impl JsonSchema for SearchMatch

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 SearchMatch

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SearchMatch

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 SearchMatch