Struct SearchHit 

pub struct SearchHit {
    pub path: String,
    pub kind: SearchKind,
    pub heading: Option<String>,
    pub line_start: Option<usize>,
    pub line_end: Option<usize>,
    pub score: f64,
    pub text: String,
}

Structured search result.

Fields

path: String

Package-internal source path.

kind: SearchKind

Hit kind.

heading: Option<String>

Nearest Markdown heading or logical metadata title.

line_start: Option<usize>

1-based starting line when known.

line_end: Option<usize>

1-based ending line when known.

score: f64

BM25 relevance score.

text: String

Indexed text snippet.

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