Struct DiskOrderedCursor 

pub struct DiskOrderedCursor<'env> { /* private fields */ }

A cursor that returns records in on-disk order rather than key order.

See the module-level docs for trade-offs and consistency guarantees.

Lifetime

The lifetime parameter 'env ties the cursor to the borrow of the Database slice passed to Database::open_disk_ordered_cursor and open_disk_ordered_cursor_multi, preventing the application from closing a database while the cursor is still scanning.

Example

use noxu_db::{DatabaseEntry, DiskOrderedCursorConfig, OperationStatus};

let mut cursor = db.open_disk_ordered_cursor(
    DiskOrderedCursorConfig::new().with_queue_size(64),
)?;
let mut key = DatabaseEntry::new();
let mut data = DatabaseEntry::new();

while cursor.next(&mut key, &mut data)? == OperationStatus::Success {
    // ...process key + data...
}
cursor.close()?;

Implementations

impl<'env> DiskOrderedCursor<'env>

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

Advances the cursor to the next record.

On Ok(Success) the key and data DatabaseEntrys are populated with the next record’s bytes. On Ok(NotFound) the cursor has reached end-of-log and no further records will be returned (it is safe — and idempotent — to call again).

Errors

• NoxuError::CursorClosed if Self::close has been called.
• NoxuError::IoError / NoxuError::LogChecksumMismatch if the producer thread reported a permanent log-read error.

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

Returns the most recent record yielded by Self::next without advancing.

Returns OperationStatus::NotFound if the cursor has not yet been advanced or has reached end-of-log.

pub fn close(self) -> Result<()>

Closes the cursor, signalling and joining the producer thread.

Idempotent — calling close on an already-closed cursor is a no-op and returns Ok(()). This is also called automatically when the cursor is dropped, so applications using RAII can rely on the drop glue rather than calling close explicitly.

Trait Implementations

impl Drop for DiskOrderedCursor<'_>

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.