Struct rkv::RoCursor

pub struct RoCursor<'txn> { /* fields omitted */ }

A read-only cursor for navigating the items within a database.

Trait Implementations

impl<'txn> Drop for RoCursor<'txn>

fn drop(&mut self)

Executes the destructor for this type.

impl<'txn> Cursor<'txn> for RoCursor<'txn>

fn cursor(&self) -> *mut MDB_cursor

Returns a raw pointer to the underlying LMDB cursor.

fn get(
    &self,
    key: Option<&[u8]>,
    data: Option<&[u8]>,
    op: u32
) -> Result<(Option<&'txn [u8]>, &'txn [u8]), Error>

Retrieves a key/data pair from the cursor. Depending on the cursor op, the current key may be returned.

Important traits for Iter<'txn>

impl<'txn> Iterator for Iter<'txn> type Item = Result<(&'txn [u8], &'txn [u8]), Error>;

fn iter(&mut self) -> Iter<'txn>

Iterate over database items. The iterator will begin with item next after the cursor, and continue until the end of the database. For new cursors, the iterator will begin with the first item in the database.

Important traits for Iter<'txn>

impl<'txn> Iterator for Iter<'txn> type Item = Result<(&'txn [u8], &'txn [u8]), Error>;

fn iter_start(&mut self) -> Iter<'txn>

Iterate over database items starting from the beginning of the database.

Important traits for Iter<'txn>

impl<'txn> Iterator for Iter<'txn> type Item = Result<(&'txn [u8], &'txn [u8]), Error>;

fn iter_from<K>(&mut self, key: K) -> Iter<'txn> where
    K: AsRef<[u8]>, 

Iterate over database items starting from the given key.

fn iter_dup(&mut self) -> IterDup<'txn>

Iterate over duplicate database items. The iterator will begin with the item next after the cursor, and continue until the end of the database. Each item will be returned as an iterator of its duplicates.

fn iter_dup_start(&mut self) -> IterDup<'txn>

Iterate over duplicate database items starting from the beginning of the database. Each item will be returned as an iterator of its duplicates.

fn iter_dup_from<K>(&mut self, key: K) -> IterDup<'txn> where
    K: AsRef<[u8]>, 

Iterate over duplicate items in the database starting from the given key. Each item will be returned as an iterator of its duplicates.

Important traits for Iter<'txn>

impl<'txn> Iterator for Iter<'txn> type Item = Result<(&'txn [u8], &'txn [u8]), Error>;

fn iter_dup_of<K>(&mut self, key: K) -> Iter<'txn> where
    K: AsRef<[u8]>, 

Iterate over the duplicates of the item in the database with the given key.

impl<'txn> Debug for RoCursor<'txn>

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

Formats the value using the given formatter.