Trait SearchEntry

pub trait SearchEntry {
    type Id: Eq;

    // Required method
    fn id(&self) -> &Self::Id;

    // Provided methods
    fn score(&self) -> Score { ... }
    fn to_entry(&self) -> EntryInfo<Self::Id>
       where Self::Id: Clone { ... }
}

A search result entry with a unique document identifier and a similarity score. Types need to implement this type in order to be admitted as a search result.

Required Associated Types

type Id: Eq

The unique document identifier type.

Required Methods

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

Retrieves this entry’s document ID.

Provided Methods

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.

Implementations on Foreign Types

impl<'a, T> SearchEntry for &'a T

where T: SearchEntry + ?Sized,

type Id = <T as SearchEntry>::Id

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

fn score(&self) -> Score

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

where Self::Id: Clone,

Implementors

impl SearchEntry for TrecEntryOwned

type Id = String

impl<'a> SearchEntry for TrecEntry<'a>

type Id = &'a str

impl<I> SearchEntry for EntryInfo<I>

where I: Eq,

type Id = I

impl<I> SearchEntry for RankedEntryInfo<I>

where I: Eq,

type Id = I

impl<T> SearchEntry for Ranked<T>

where T: SearchEntry,

type Id = <T as SearchEntry>::Id