Struct dittolive_ditto::store::dql::QueryResult

pub struct QueryResult { /* private fields */ }

Represents results returned when executing a DQL query containing a QueryResultItem for each match.

Note: More info such as metrics, affected document IDs, etc. will be provided in the near future.

Implementations

impl QueryResult

pub fn get_item(&self, index: usize) -> Option<QueryResultItem>

Get the QueryResultItem at the given index. Return None if out of bounds.

pub fn item_count(&self) -> usize

Return the number of available QueryResultItem.

pub fn mutated_document_ids(&self) -> Vec<DocumentId>

IDs of documents that were mutated by the DQL query. Empty array if no documents have been mutated.

Important: The returned document IDs are not cached, make sure to call this method once and keep the return value for as long as needed.

impl QueryResult

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

Trait Implementations

impl From<Box<QueryResult>> for QueryResult

fn from(raw: Box<QueryResult>) -> QueryResult

Converts to this type from the input type.

impl<'iter> IntoIterator for &'iter QueryResult

type IntoIter = QueryResultIterator<'iter>

Which kind of iterator are we turning this into?

type Item = QueryResultItem

The type of the elements being iterated over.

fn into_iter(self) -> QueryResultIterator<'iter>

Creates an iterator from a value.