Struct SearchResult 

pub struct SearchResult {
    pub entities: Vec<Entity>,
    pub query: String,
    pub deep_search_used: bool,
    pub query_variations: Vec<String>,
}

Result from a search operation.

Contains the matched entities along with metadata about the search.

Fields

entities: Vec<Entity>

The matched entities, sorted by relevance.

query: String

The original query.

deep_search_used: bool

Whether deep search was actually used.

query_variations: Vec<String>

Query variations used (includes original if deep search was used).

Implementations

impl SearchResult

pub fn new( entities: Vec<Entity>, query: impl Into<String>, deep_search_used: bool, query_variations: Vec<String>, ) -> Self

Create a new search result.

pub fn fast_only(entities: Vec<Entity>, query: impl Into<String>) -> Self

Create a fast-only search result.

pub fn len(&self) -> usize

Get the number of results.

pub fn is_empty(&self) -> bool

Check if results are empty.

pub fn first(&self) -> Option<&Entity>

Get the first entity if any.

pub fn iter(&self) -> impl Iterator<Item = &Entity>

Iterate over entities.

Trait Implementations

impl Clone for SearchResult

fn clone(&self) -> SearchResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResult

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

Formats the value using the given formatter.

impl IntoIterator for SearchResult

type Item = Entity

The type of the elements being iterated over.

type IntoIter = IntoIter<Entity>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.