Struct reth_libmdbx::Cursor
source · pub struct Cursor<K>where
K: TransactionKind,{ /* private fields */ }Expand description
A cursor for navigating the items within a database.
Implementations§
source§impl<K> Cursor<K>where
K: TransactionKind,
impl<K> Cursor<K>where
K: TransactionKind,
sourcepub const fn cursor(&self) -> *mut MDBX_cursor
pub const fn cursor(&self) -> *mut MDBX_cursor
Returns a raw pointer to the underlying MDBX cursor.
The caller must ensure that the pointer is not used after the lifetime of the cursor.
sourcepub fn iter_slices<'a>(
&'a self,
) -> IntoIter<'a, K, Cow<'a, [u8]>, Cow<'a, [u8]>>
pub fn iter_slices<'a>( &'a self, ) -> IntoIter<'a, K, Cow<'a, [u8]>, Cow<'a, [u8]>>
Returns an iterator over the raw key value slices.
sourcepub fn into_iter<Key, Value>(&self) -> IntoIter<'_, K, Key, Value>where
Key: TableObject,
Value: TableObject,
pub fn into_iter<Key, Value>(&self) -> IntoIter<'_, K, Key, Value>where
Key: TableObject,
Value: TableObject,
Returns an iterator over database items.
sourcepub fn first<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn first<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at first key/data item.
sourcepub fn first_dup<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
pub fn first_dup<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
DatabaseFlags::DUP_SORT-only: Position at first data item of current key.
sourcepub fn get_both<Value>(&mut self, k: &[u8], v: &[u8]) -> Result<Option<Value>>where
Value: TableObject,
pub fn get_both<Value>(&mut self, k: &[u8], v: &[u8]) -> Result<Option<Value>>where
Value: TableObject,
DatabaseFlags::DUP_SORT-only: Position at key/data pair.
sourcepub fn get_both_range<Value>(
&mut self,
k: &[u8],
v: &[u8],
) -> Result<Option<Value>>where
Value: TableObject,
pub fn get_both_range<Value>(
&mut self,
k: &[u8],
v: &[u8],
) -> Result<Option<Value>>where
Value: TableObject,
DatabaseFlags::DUP_SORT-only: Position at given key and at first data greater than or
equal to specified data.
sourcepub fn get_current<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn get_current<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Return key/data at current cursor position.
sourcepub fn get_multiple<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
pub fn get_multiple<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
DupFixed-only: Return up to a page of duplicate data items from current cursor position.
Move cursor to prepare for Self::next_multiple().
sourcepub fn last<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn last<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at last key/data item.
sourcepub fn last_dup<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
pub fn last_dup<Value>(&mut self) -> Result<Option<Value>>where
Value: TableObject,
DupSort-only: Position at last data item of current key.
sourcepub fn next<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn next<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at next data item
sourcepub fn next_dup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn next_dup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
DatabaseFlags::DUP_SORT-only: Position at next data item of current key.
sourcepub fn next_multiple<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn next_multiple<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
DatabaseFlags::DUP_FIXED-only: Return up to a page of duplicate data items from next
cursor position. Move cursor to prepare for MDBX_NEXT_MULTIPLE.
sourcepub fn next_nodup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn next_nodup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at first data item of next key.
sourcepub fn prev<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn prev<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at previous data item.
sourcepub fn prev_dup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn prev_dup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
DatabaseFlags::DUP_SORT-only: Position at previous data item of current key.
sourcepub fn prev_nodup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn prev_nodup<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at last data item of previous key.
sourcepub fn set<Value>(&mut self, key: &[u8]) -> Result<Option<Value>>where
Value: TableObject,
pub fn set<Value>(&mut self, key: &[u8]) -> Result<Option<Value>>where
Value: TableObject,
Position at specified key.
sourcepub fn set_key<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn set_key<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at specified key, return both key and data.
sourcepub fn set_range<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn set_range<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at first key greater than or equal to specified key.
sourcepub fn prev_multiple<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn prev_multiple<Key, Value>(&mut self) -> Result<Option<(Key, Value)>>where
Key: TableObject,
Value: TableObject,
DatabaseFlags::DUP_FIXED-only: Position at previous page and return up to a page of
duplicate data items.
sourcepub fn set_lowerbound<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(bool, Key, Value)>>where
Key: TableObject,
Value: TableObject,
pub fn set_lowerbound<Key, Value>(
&mut self,
key: &[u8],
) -> Result<Option<(bool, Key, Value)>>where
Key: TableObject,
Value: TableObject,
Position at first key-value pair greater than or equal to specified, return both key and data, and the return code depends on a exact match.
For non DupSort-ed collections this works the same as Self::set_range(), but returns
false if key found exactly and true if greater key was found.
For DupSort-ed a data value is taken into account for duplicates, i.e. for a pairs/tuples of a key and an each data value of duplicates. Returns false if key-value pair found exactly and true if the next pair was returned.
sourcepub fn iter<Key, Value>(&mut self) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter<Key, Value>(&mut self) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Returns an iterator 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.
For databases with duplicate data items (DatabaseFlags::DUP_SORT), the
duplicate data items of each key will be returned before moving on to
the next key.
sourcepub fn iter_start<Key, Value>(&mut self) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_start<Key, Value>(&mut self) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Iterate over database items starting from the beginning of the database.
For databases with duplicate data items (DatabaseFlags::DUP_SORT), the
duplicate data items of each key will be returned before moving on to
the next key.
sourcepub fn iter_from<Key, Value>(&mut self, key: &[u8]) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_from<Key, Value>(&mut self, key: &[u8]) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Iterate over database items starting from the given key.
For databases with duplicate data items (DatabaseFlags::DUP_SORT), the
duplicate data items of each key will be returned before moving on to
the next key.
sourcepub fn iter_dup<Key, Value>(&mut self) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_dup<Key, Value>(&mut self) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
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.
sourcepub fn iter_dup_start<Key, Value>(&mut self) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_dup_start<Key, Value>(&mut self) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Iterate over duplicate database items starting from the beginning of the database. Each item will be returned as an iterator of its duplicates.
sourcepub fn iter_dup_from<Key, Value>(
&mut self,
key: &[u8],
) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_dup_from<Key, Value>(
&mut self,
key: &[u8],
) -> IterDup<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Iterate over duplicate items in the database starting from the given key. Each item will be returned as an iterator of its duplicates.
sourcepub fn iter_dup_of<Key, Value>(&mut self, key: &[u8]) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
pub fn iter_dup_of<Key, Value>(&mut self, key: &[u8]) -> Iter<'_, K, Key, Value> ⓘwhere
Key: TableObject,
Value: TableObject,
Iterate over the duplicates of the item in the database with the given key.
source§impl Cursor<RW>
impl Cursor<RW>
sourcepub fn put(&mut self, key: &[u8], data: &[u8], flags: WriteFlags) -> Result<()>
pub fn put(&mut self, key: &[u8], data: &[u8], flags: WriteFlags) -> Result<()>
Puts a key/data pair into the database. The cursor will be positioned at the new data item, or on failure usually near it.
sourcepub fn del(&mut self, flags: WriteFlags) -> Result<()>
pub fn del(&mut self, flags: WriteFlags) -> Result<()>
Deletes the current key/data pair.
§Flags
WriteFlags::NO_DUP_DATA may be used to delete all data items for the
current key, if the database was opened with DatabaseFlags::DUP_SORT.
Trait Implementations§
source§impl<K> Clone for Cursor<K>where
K: TransactionKind,
impl<K> Clone for Cursor<K>where
K: TransactionKind,
source§impl<K> Debug for Cursor<K>where
K: TransactionKind,
impl<K> Debug for Cursor<K>where
K: TransactionKind,
source§impl<K> Drop for Cursor<K>where
K: TransactionKind,
impl<K> Drop for Cursor<K>where
K: TransactionKind,
impl<K> Send for Cursor<K>where
K: TransactionKind,
impl<K> Sync for Cursor<K>where
K: TransactionKind,
Auto Trait Implementations§
impl<K> Freeze for Cursor<K>
impl<K> !RefUnwindSafe for Cursor<K>
impl<K> Unpin for Cursor<K>
impl<K> !UnwindSafe for Cursor<K>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
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: 16 bytes