Struct SearchHit 

pub struct SearchHit {
    pub resource: ResourceId,
    pub locator: ResourceLocator,
    pub score: f32,
    pub signals: MatchSignals,
    pub match: MatchReason,
    pub metadata: ResourceMetadata,
    pub heading: Option<String>,
    pub preview: Option<String>,
    pub query_index: usize,
}

One ranked match.

Fields

resource: ResourceId

locator: ResourceLocator

score: f32

Relevance. In hybrid and lexical mode a rank fusion in (0, 1], where 1 means first on every signal that found anything; in semantic mode the cosine similarity. Only comparable within one search.

signals: MatchSignals

What found this hit. Use it to tell a meaning match from a name match.

match: MatchReason

Rank provenance, additive to the existing raw signal scores.

metadata: ResourceMetadata

heading: Option<String>

Markdown heading path of the segment, when there is one.

preview: Option<String>

A short excerpt of the matched segment (text resources only).

query_index: usize

Index into SearchResults::queries of the query that scored best here. Meaningful only when MatchSignals::semantic is present.

Trait Implementations

impl Clone for SearchHit

fn clone(&self) -> Self

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

fn eq(&self, other: &Self) -> 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