Struct Cursor 

pub struct Cursor<K, T>
where
    K: TransactionKind,
    T: Table,
{ /* private fields */ }

Available on crate feature provider only.

Cursor wrapper to access KV items.

Trait Implementations

impl<K, T> DbCursorRO<T> for Cursor<K, T>

where K: TransactionKind, T: Table,

fn first( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Positions the cursor at the first entry in the table, returning it.

fn seek_exact( &mut self, key: <T as Table>::Key, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Seeks to the KV pair exactly at key.

fn seek( &mut self, key: <T as Table>::Key, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Seeks to the KV pair whose key is greater than or equal to key.

fn next( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Position the cursor at the next KV pair, returning it.

fn prev( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Position the cursor at the previous KV pair, returning it.

fn last( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Positions the cursor at the last entry in the table, returning it.

fn current( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Get the KV pair at the cursor’s current position.

fn walk( &mut self, start_key: Option<<T as Table>::Key>, ) -> Result<Walker<'_, T, Cursor<K, T>>, DatabaseError>

Get an iterator that walks through the table.

fn walk_range( &mut self, range: impl RangeBounds<<T as Table>::Key>, ) -> Result<RangeWalker<'_, T, Cursor<K, T>>, DatabaseError>

Get an iterator that walks over a range of keys in the table.

fn walk_back( &mut self, start_key: Option<<T as Table>::Key>, ) -> Result<ReverseWalker<'_, T, Cursor<K, T>>, DatabaseError>

Get an iterator that walks through the table in reverse order.

impl<T> DbCursorRW<T> for Cursor<RW, T>

where T: Table,

fn upsert( &mut self, key: <T as Table>::Key, value: &<T as Table>::Value, ) -> Result<(), DatabaseError>

Database operation that will update an existing row if a specified value already exists in a table, and insert a new row if the specified value doesn’t already exist

For a DUPSORT table, upsert will not actually update-or-insert. If the key already exists, it will append the value to the subkey, even if the subkeys are the same. So if you want to properly upsert, you’ll need to seek_exact & delete_current if the key+subkey was found, before calling upsert.

fn append( &mut self, key: <T as Table>::Key, value: &<T as Table>::Value, ) -> Result<(), DatabaseError>

Appends the data to the end of the table. Consequently, the append operation will fail if the inserted key is less than the last table key

fn insert( &mut self, key: <T as Table>::Key, value: &<T as Table>::Value, ) -> Result<(), DatabaseError>

Database operation that will insert a row at a given key. If the key is already present, the operation will result in an error.

fn delete_current(&mut self) -> Result<(), DatabaseError>

Delete current value that cursor points to

impl<K, T> DbDupCursorRO<T> for Cursor<K, T>

where K: TransactionKind, T: DupSort,

fn next_dup( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Returns the next (key, value) pair of a DUPSORT table.

fn next_no_dup( &mut self, ) -> Result<Option<(<T as Table>::Key, <T as Table>::Value)>, DatabaseError>

Returns the next (key, value) pair skipping the duplicates.

fn next_dup_val(&mut self) -> Result<Option<<T as Table>::Value>, DatabaseError>

Returns the next value of a duplicate key.

fn walk_dup( &mut self, key: Option<<T as Table>::Key>, subkey: Option<<T as DupSort>::SubKey>, ) -> Result<DupWalker<'_, T, Cursor<K, T>>, DatabaseError>

Depending on its arguments, returns an iterator starting at:

• Some(key), Some(subkey): a key item whose data is >= than subkey
• Some(key), None: first item of a specified key
• None, Some(subkey): like first case, but in the first key
• None, None: first item in the table of a DUPSORT table.

fn seek_by_key_subkey( &mut self, key: <T as Table>::Key, subkey: <T as DupSort>::SubKey, ) -> Result<Option<<T as Table>::Value>, DatabaseError>

Positions the cursor at the entry greater than or equal to the provided key/subkey pair.

impl<T> DbDupCursorRW<T> for Cursor<RW, T>

where T: DupSort,

fn delete_current_duplicates(&mut self) -> Result<(), DatabaseError>

Delete all duplicate entries for current key.

fn append_dup( &mut self, key: <T as Table>::Key, value: <T as Table>::Value, ) -> Result<(), DatabaseError>

Append duplicate value.

impl<K, T> Debug for Cursor<K, T>

where K: Debug + TransactionKind, T: Debug + Table,

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes