Struct iroh_docs::store::QueryBuilder

pub struct QueryBuilder<K> { /* private fields */ }

A query builder for document queries.

Implementations

impl<K> QueryBuilder<K>

pub fn include_empty(self) -> Self

Call to include empty entries (deletion markers).

pub fn key_exact(self, key: impl AsRef<[u8]>) -> Self

Filter by exact key match.

pub fn key_prefix(self, key: impl AsRef<[u8]>) -> Self

Filter by key prefix.

pub fn author(self, author: AuthorId) -> Self

Filter by author.

pub fn limit(self, limit: u64) -> Self

Set the maximum number of entries to be returned.

pub fn offset(self, offset: u64) -> Self

Set the offset within the result set from where to start returning results.

impl QueryBuilder<FlatQuery>

pub fn sort_by(self, sort_by: SortBy, direction: SortDirection) -> Self

Set the sort for the query.

The default is to sort by author, then by key, in ascending order.

pub fn build(self) -> Query

Build the query.

impl QueryBuilder<SingleLatestPerKeyQuery>

pub fn sort_direction(self, direction: SortDirection) -> Self

Set the order direction for the query.

Ordering is always by key for this query type. Default direction is ascending.

pub fn build(self) -> Query

Build the query.

Trait Implementations

impl<K: Debug> Debug for QueryBuilder<K>

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

Formats the value using the given formatter.

impl<K: Default> Default for QueryBuilder<K>

fn default() -> QueryBuilder<K>

Returns the “default value” for a type.

impl From<QueryBuilder<FlatQuery>> for Query

fn from(builder: QueryBuilder<FlatQuery>) -> Query

Converts to this type from the input type.

impl From<QueryBuilder<SingleLatestPerKeyQuery>> for Query

fn from(builder: QueryBuilder<SingleLatestPerKeyQuery>) -> Query

Converts to this type from the input type.