Struct JoinCursor 

pub struct JoinCursor<'a> { /* private fields */ }

A cursor that returns records satisfying all secondary-key constraints.

Obtained via Database::join.

The cursor owns the SecondaryCursor objects for the duration of the join. When close is called (or the cursor is dropped), the internal cursors are released. The caller’s original cursor variables have been moved in so they are no longer accessible.

Implementations

impl<'a> JoinCursor<'a>

pub fn get_next( &mut self, key: &mut DatabaseEntry, data: &mut DatabaseEntry, ) -> Result<OperationStatus>

Returns the next primary key and primary record data from the join.

Returns OperationStatus::Success with key and data filled in, or OperationStatus::NotFound when there are no more matching records.

pub fn get_next_key( &mut self, key: &mut DatabaseEntry, ) -> Result<OperationStatus>

Returns the next primary key only — does not read primary data.

Equivalent to ’s JoinCursor.getNext(key, lockMode) single-arg overload. Useful when only the key is needed and avoiding a primary read is desirable.

pub fn close(self)

Closes the join cursor, releasing all internal secondary cursors.

pub fn get_database(&self) -> &Database

Returns a reference to the primary database associated with this cursor.

pub fn get_config(&self) -> JoinConfig

Returns a clone of this cursor’s configuration.

Trait Implementations

impl Drop for JoinCursor<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.