Struct vindicator::RankedEntryInfo

pub struct RankedEntryInfo<I> {
    pub id: I,
    pub score: Score,
    pub rank: Rank,
}

A simple struct for minimally describing a scored and ranked search result.

Fields

id: I

The entry's document ID.

score: Score

The entry's similarity score.

rank: Rank

The entry's rank.

Trait Implementations

impl<I> SearchEntry for RankedEntryInfo<I> where
    I: Eq, 

type Id = I

The unique document identifier type.

fn id(&self) -> &Self::Id

Retrieves this entry's document ID.

fn score(&self) -> Score

Retrieves this entry's similarity score.

fn to_entry(&self) -> EntryInfo<Self::Id> where
    Self::Id: Clone, 

Constructs a minimalist entry info data structure.

impl<I> RankedSearchEntry for RankedEntryInfo<I> where
    I: Eq, 

fn rank(&self) -> Rank

impl<I: Eq> Eq for RankedEntryInfo<I>

impl<I: Clone> Clone for RankedEntryInfo<I>

fn clone(&self) -> RankedEntryInfo<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Copy> Copy for RankedEntryInfo<I>

impl<I: PartialEq> PartialEq<RankedEntryInfo<I>> for RankedEntryInfo<I>

fn eq(&self, other: &RankedEntryInfo<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RankedEntryInfo<I>) -> bool

This method tests for !=.

impl<I: Debug> Debug for RankedEntryInfo<I>

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

Formats the value using the given formatter.