Struct Hit 

pub struct Hit {
    pub id: VectorId,
    pub distance: f32,
    pub metadata: Option<Metadata>,
}

One result of a similarity search: a matched record and its distance.

id identifies the matched vector, distance is its distance from the query under the search’s metric (smaller is nearer), and metadata is the record’s metadata when the engine was asked to return it. Build a bare hit with Hit::new and attach metadata by setting the field.

Examples

use iqdb_types::{Hit, VectorId};

let hit = Hit::new(VectorId::from(42u64), 0.125);
assert_eq!(hit.id, VectorId::U64(42));
assert_eq!(hit.distance, 0.125);
assert!(hit.metadata.is_none());

Fields

id: VectorId

The identifier of the matched vector.

distance: f32

The distance from the query under the search’s metric (smaller is nearer).

metadata: Option<Metadata>

The record’s metadata, when the search was asked to return it.

Implementations

impl Hit

pub fn new(id: VectorId, distance: f32) -> Self

Creates a hit for id at distance, with no metadata attached.

Examples

use iqdb_types::{Hit, VectorId};

let hit = Hit::new(VectorId::from(1u64), 2.5);
assert_eq!(hit.distance, 2.5);
assert!(hit.metadata.is_none());

Trait Implementations

impl Clone for Hit

fn clone(&self) -> Hit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Hit

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

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 Hit