Struct VectorHit 

#[non_exhaustive]
pub struct VectorHit {
    pub node_id: NodeId,
    pub score: f32,
}

One scored match returned by a VectorIndex search.

#[non_exhaustive] keeps field adds backward-compatible for downstream match sites; callers in sibling crates (e.g. mnem-ann) build instances via VectorHit::new.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

node_id: NodeId

The matched node’s stable identity.

score: f32

Cosine similarity in [-1.0, 1.0]. Higher is closer.

Implementations

impl VectorHit

pub const fn new(node_id: NodeId, score: f32) -> Self

Construct a hit. Prefer this over a struct literal from external crates since VectorHit is #[non_exhaustive].

Trait Implementations

impl Clone for VectorHit

fn clone(&self) -> VectorHit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorHit

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

Formats the value using the given formatter.

impl PartialEq for VectorHit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VectorHit