Struct 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.

pub fn commit_id(&self) -> Option<NonZeroU64>

The commit ID associated with this query result, if any.

This ID uniquely identifies the commit in which this change was accepted into the local store. The commit ID is available for all query results involving insertions, updates, or deletions. This ID can be used to track whether a local change has been synced to other peers.

For write transactions, the commit ID is only available after the transaction has been successfully committed. Queries executed within an uncommitted transaction will not have a commit ID.

impl QueryResult

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

Create an iterator over QueryResultItems

Trait Implementations

impl From<Box<FfiQueryResult>> for QueryResult

fn from(raw: Box<FfiQueryResult>) -> 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.