Struct SearchHit 

pub struct SearchHit {
    pub ordinal: u32,
    pub outline: OutlineTrail,
    pub occurrences: Vec<SearchOccurrence>,
    pub occurrence_count: u32,
    pub occurrences_truncated: bool,
    pub node_source: Option<SourceSpan>,
    pub preview: String,
    pub context: Vec<SearchContextLine>,
}

One rendered line or line span containing one or more exact occurrences.

Fields

ordinal: u32

One-based line-group number in the unpaginated result set.

outline: OutlineTrail

Complete logical location of the nearest addressable node.

occurrences: Vec<SearchOccurrence>

Exact matcher occurrences on this rendered line or line span.

occurrence_count: u32

Total exact matcher occurrences represented by this line group.

occurrences_truncated: bool

Whether Self::occurrences omits exact ranges to remain bounded.

node_source: Option<SourceSpan>

Original-source location of the owning outline node, when retained.

preview: String

Compact single-string presentation of the match.

context: Vec<SearchContextLine>

Optional rendered lines surrounding the match.

Trait Implementations

impl Clone for SearchHit

fn clone(&self) -> SearchHit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchHit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchHit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SearchHit

impl JsonSchema for SearchHit

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 SearchHit

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SearchHit

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 SearchHit