Struct KvListBuilder 

pub struct KvListBuilder { /* private fields */ }

Builder for flexible queries over a key/value backend.

Use prefix, start, and end keys to define your query range, then call KvListBuilder::entries.

Examples

use stupid_simple_kv::{Kv, MemoryBackend, KvValue, IntoKey};
let mut kv = Kv::new(Box::new(MemoryBackend::new()));

// List all pairs with prefix (1, _)
let pairs = kv.list().prefix(&(1u64,)).entries().unwrap();

// Range scan from (99,2) up to (99,5)
let result = kv.list().start(&(99u64, 2i64)).end(&(99u64, 5i64)).entries().unwrap();

Implementations

impl KvListBuilder

pub fn prefix(&mut self, prefix: &dyn IntoKey) -> &mut Self

Restrict results to the given key prefix.

pub fn start(&mut self, start: &dyn IntoKey) -> &mut Self

Start listing at this key (inclusive).

pub fn end(&mut self, end: &dyn IntoKey) -> &mut Self

End listing at this key (exclusive).

pub fn entries(&self) -> KvResult<Vec<(KvKey, KvValue)>>

Run the current query and return key-value pairs. Returns all results matching the filter/prefix/bounds.

Errors

Returns an error if the combination of selectors is invalid, or if decoding fails.