Struct iroh_docs::store::Query

pub struct Query { /* private fields */ }

Note: When using the SingleLatestPerKey query kind, the key filter is applied before the grouping, the author filter is applied after the grouping.

Implementations

impl Query

pub fn all() -> QueryBuilder<FlatQuery>

Query all records.

pub fn single_latest_per_key() -> QueryBuilder<SingleLatestPerKeyQuery>

Query only the latest entry for each key, omitting older entries if the entry was written to by multiple authors.

pub fn author(author: AuthorId) -> QueryBuilder<FlatQuery>

Create a Query::all query filtered by a single author.

pub fn key_exact(key: impl AsRef<[u8]>) -> QueryBuilder<FlatQuery>

Create a Query::all query filtered by a single key.

pub fn key_prefix(prefix: impl AsRef<[u8]>) -> QueryBuilder<FlatQuery>

Create a Query::all query filtered by a key prefix.

pub fn limit(&self) -> Option<u64>

Get the limit for this query (max. number of entries to emit).

pub fn offset(&self) -> u64

Get the offset for this query (number of entries to skip at the beginning).

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Query

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

impl Serialize for Query

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.