Struct elipdotter::query::Hit

pub struct Hit { /* private fields */ }

An occurrence returned from Query.

Implementations

impl Hit

pub fn id(&self) -> Id

Get a reference to the hit’s document id.

pub fn word_id(&self) -> u32

Get a reference to the hit’s word id.

pub fn start(&self) -> usize

Get a reference to the hit’s document id.

This might be any of the Self::occurrences if that returns any items.

pub fn occurrence(&self) -> &Occurence

Get a reference to the hit’s occurrence.

pub fn rating(&self) -> f32

Get the hit’s rating.

pub fn occurrences(&self) -> impl Iterator<Item = AssociatedOccurrence> + '_

Self::occurrence and all associated occurrences.

Trait Implementations

impl Clone for Hit

fn clone(&self) -> Hit

Returns a copy 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 From<&Hit> for AssociatedOccurrence

fn from(hit: &Hit) -> Self

Converts to this type from the input type.

impl Ord for Hit

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Hit> for Hit

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

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

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

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

impl PartialOrd<Hit> for Hit

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Hit