Struct CursorConfig 

pub struct CursorConfig {
    pub read_uncommitted: bool,
}

Configuration for opening a cursor.

Specifies the configuration parameters used to open a cursor on a database.

Changes in v1.5.1

Four fields that used to live on this struct (read_committed, non_sticky, evict_ln, prefix_constraint) were removed because the engine never consulted them. See docs/src/internal/v1.5-decisions-2026-05.md for the full rationale and migration notes.

• read_committed — to use read-committed isolation, set it on the surrounding crate::transaction_config::TransactionConfig (it is honoured by crate::cursor::Cursor via the txn’s locker) or pass crate::lock_mode::LockMode::ReadCommitted to a per-operation crate::read_options::ReadOptions.
• non_sticky — Rust cursors are bound to their owning scope and are not sticky to a transaction in the JE sense; the flag had no observable effect.
• evict_ln — use crate::cache_mode::CacheMode::Unchanged / EvictLn on the surrounding DatabaseConfig instead.
• prefix_constraint — application code should compare the returned key against its own prefix and stop iterating; the engine’s BIN-level prefix is independent of the user’s range-scan termination condition.

Fields

read_uncommitted: bool

Use read-uncommitted isolation (dirty reads).

When true, the cursor is opened in read-only mode and skips read-lock acquisition. This mirrors JE’s CursorConfig.setReadUncommitted(true) shape and is the only isolation override consulted at cursor-open time. Per-operation LockMode overrides (passed via crate::read_options::ReadOptions) take precedence at the individual get call.

Implementations

impl CursorConfig

pub fn new() -> CursorConfig

Creates a new CursorConfig with default settings.

pub fn set_read_uncommitted( &mut self, read_uncommitted: bool, ) -> &mut CursorConfig

Sets read-uncommitted isolation.

pub fn with_read_uncommitted(self, read_uncommitted: bool) -> CursorConfig

Builder-style method to set read_uncommitted.

pub fn read_uncommitted() -> CursorConfig

Creates a CursorConfig for read-uncommitted isolation.

Trait Implementations

impl Clone for CursorConfig

fn clone(&self) -> CursorConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CursorConfig

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

Formats the value using the given formatter.

impl Default for CursorConfig

fn default() -> CursorConfig

Returns the “default value” for a type.

impl Eq for CursorConfig

impl PartialEq for CursorConfig

fn eq(&self, other: &CursorConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CursorConfig