Struct EngineConfig 

pub struct EngineConfig {

    pub home: PathBuf,
    pub allow_create: bool,
    pub transactional: bool,
    pub read_only: bool,
    pub cache_size: u64,
    pub lock_table_count: u32,
    pub lock_timeout_ms: u64,
    pub txn_timeout_ms: u64,
    pub evictor_enabled: bool,
    pub cleaner_enabled: bool,
    pub checkpointer_enabled: bool,
    pub checkpoint_bytes_interval: u64,
    pub cleaner_min_utilization: u32,
    pub cleaner_min_file_count: u32,
    pub evictor_wakeup_interval_ms: u64,
    pub cleaner_wakeup_interval_ms: u64,
    pub checkpointer_wakeup_interval_ms: u64,
    pub log_file_max: u64,
    pub log_mem_only: bool,
    pub log_checksum_read: bool,
    pub log_total_buffer_bytes: u64,
    pub evictor_evict_bytes: u64,
    pub evictor_core_threads: u32,
    pub evictor_max_threads: u32,
    pub evictor_n_lru_lists: u32,
    pub cleaner_min_file_utilization: u32,
    pub cleaner_threads: u32,
    pub cleaner_lock_timeout_ms: u64,
    pub txn_serializable_isolation: bool,
    pub lock_deadlock_detect: bool,
    pub checkpointer_high_priority: bool,
}

Configuration for the Noxu DB engine.

Aggregates all configuration that affects environment behavior. This is the primary configuration structure for opening an environment.

Fields

home: PathBuf

Environment home directory.

All database files are stored in this directory.

allow_create: bool

Whether to create the environment if it doesn’t exist.

transactional: bool

Whether transactions are enabled.

When true, the transaction manager is active and all database operations can optionally be transactional.

read_only: bool

Whether the environment is read-only.

Read-only environments cannot modify the database or log files.

cache_size: u64

Maximum cache size in bytes.

Controls the memory budget for the in-memory B-tree cache.

lock_table_count: u32

Maximum number of lock tables (shards).

Higher values reduce contention but increase memory overhead.

lock_timeout_ms: u64

Lock timeout in milliseconds (0 = no timeout).

Maximum time to wait for a lock before timing out.

txn_timeout_ms: u64

Transaction timeout in milliseconds (0 = no timeout).

Maximum time a transaction can run before timing out.

evictor_enabled: bool

Whether to run the evictor daemon.

The evictor daemon runs in the background evicting nodes from the cache when memory budget is exceeded.

cleaner_enabled: bool

Whether to run the cleaner daemon.

The cleaner daemon runs in the background performing log file garbage collection.

checkpointer_enabled: bool

Whether to run the checkpointer daemon.

The checkpointer daemon runs in the background performing periodic checkpoints to bound recovery time.

checkpoint_bytes_interval: u64

Checkpoint bytes interval.

A checkpoint is performed after approximately this many bytes have been written to the log (0 = disabled).

cleaner_min_utilization: u32

Cleaner minimum utilization (0-100).

Log files below this utilization percentage are candidates for cleaning.

cleaner_min_file_count: u32

Cleaner minimum file count.

The cleaner won’t run until at least this many log files exist.

evictor_wakeup_interval_ms: u64

Evictor wakeup interval in milliseconds.

How often the evictor daemon wakes up to check if eviction is needed.

cleaner_wakeup_interval_ms: u64

Cleaner wakeup interval in milliseconds.

How often the cleaner daemon wakes up to check if cleaning is needed.

checkpointer_wakeup_interval_ms: u64

Checkpointer wakeup interval in milliseconds.

How often the checkpointer daemon wakes up to check if checkpoint is needed.

log_file_max: u64

Maximum size of each log file in bytes (je.log.fileMax).

Range: 1 MB – 1 GB. Default: 10 MB.

log_mem_only: bool

Whether the environment uses an in-memory log only (je.log.memOnly).

When true, no files are written and the log lives entirely in memory.

log_checksum_read: bool

Whether to verify checksums when reading log entries (je.log.checksumRead).

log_total_buffer_bytes: u64

Total bytes to use for log write buffers (je.log.totalBufferBytes).

0 means compute automatically from max_memory.

evictor_evict_bytes: u64

Number of bytes to evict per eviction pass (je.evictor.evictBytes).

Default: 512 KB.

evictor_core_threads: u32

Number of evictor core threads (je.evictor.coreThreads).

evictor_max_threads: u32

Maximum number of evictor threads (je.evictor.maxThreads).

evictor_n_lru_lists: u32

Number of LRU lists for the evictor (je.evictor.nLRULists).

More lists reduce contention. Range: 1–32. Default: 4.

cleaner_min_file_utilization: u32

Minimum per-file utilization (je.cleaner.minFileUtilization).

Files below this percentage are cleaned regardless of overall utilization. Range: 0–50. Default: 5.

cleaner_threads: u32

Number of cleaner threads (je.cleaner.threads).

Default: 1.

cleaner_lock_timeout_ms: u64

Lock timeout for cleaner operations in milliseconds (je.cleaner.lockTimeout).

Default: 500 ms.

txn_serializable_isolation: bool

If true, all transactions use serializable isolation (je.txn.serializableIsolation).

lock_deadlock_detect: bool

If true, deadlock detection is enabled (je.lock.deadlockDetect).

checkpointer_high_priority: bool

If true, the checkpointer runs at high priority (je.checkpointer.highPriority).

Implementations

impl EngineConfig

pub fn new(home: impl Into<PathBuf>) -> Self

Create a new EngineConfig with the given home directory.

pub fn allow_create(self, allow: bool) -> Self

Set whether to create the environment if it doesn’t exist.

pub fn transactional(self, enabled: bool) -> Self

Set whether transactions are enabled.

pub fn read_only(self, read_only: bool) -> Self

Set whether the environment is read-only.

pub fn cache_size(self, size: u64) -> Self

Set the maximum cache size in bytes.

pub fn lock_table_count(self, count: u32) -> Self

Set the number of lock table shards.

pub fn lock_timeout_ms(self, timeout: u64) -> Self

Set the lock timeout in milliseconds.

pub fn txn_timeout_ms(self, timeout: u64) -> Self

Set the transaction timeout in milliseconds.

pub fn evictor_enabled(self, enabled: bool) -> Self

Enable or disable the evictor daemon.

pub fn cleaner_enabled(self, enabled: bool) -> Self

Enable or disable the cleaner daemon.

pub fn checkpointer_enabled(self, enabled: bool) -> Self

Enable or disable the checkpointer daemon.

pub fn checkpoint_bytes_interval(self, bytes: u64) -> Self

Set the checkpoint bytes interval.

pub fn cleaner_min_utilization(self, percent: u32) -> Self

Set the cleaner minimum utilization percentage.

pub fn evictor_wakeup_interval_ms(self, ms: u64) -> Self

Set the evictor wakeup interval in milliseconds.

pub fn cleaner_wakeup_interval_ms(self, ms: u64) -> Self

Set the cleaner wakeup interval in milliseconds.

pub fn checkpointer_wakeup_interval_ms(self, ms: u64) -> Self

Set the checkpointer wakeup interval in milliseconds.

pub fn log_file_max(self, bytes: u64) -> Self

Set the maximum log file size in bytes (je.log.fileMax).

pub fn log_mem_only(self, mem_only: bool) -> Self

Enable or disable in-memory-only log (je.log.memOnly).

pub fn log_checksum_read(self, enabled: bool) -> Self

Enable or disable log checksum verification on read (je.log.checksumRead).

pub fn log_total_buffer_bytes(self, bytes: u64) -> Self

Set total log buffer bytes (je.log.totalBufferBytes). 0 = auto.

pub fn evictor_evict_bytes(self, bytes: u64) -> Self

Set the number of bytes to evict per pass (je.evictor.evictBytes).

pub fn evictor_core_threads(self, n: u32) -> Self

Set the number of evictor core threads (je.evictor.coreThreads).

pub fn evictor_max_threads(self, n: u32) -> Self

Set the maximum number of evictor threads (je.evictor.maxThreads).

pub fn evictor_n_lru_lists(self, n: u32) -> Self

Set the number of LRU lists for the evictor (je.evictor.nLRULists).

pub fn cleaner_min_file_utilization(self, percent: u32) -> Self

Set the per-file minimum utilization (je.cleaner.minFileUtilization).

pub fn cleaner_threads(self, n: u32) -> Self

Set the number of cleaner threads (je.cleaner.threads).

pub fn cleaner_lock_timeout_ms(self, ms: u64) -> Self

Set the cleaner lock timeout in milliseconds (je.cleaner.lockTimeout).

pub fn txn_serializable_isolation(self, enabled: bool) -> Self

Enable or disable serializable isolation for all transactions.

pub fn lock_deadlock_detect(self, enabled: bool) -> Self

Enable or disable automatic deadlock detection.

pub fn checkpointer_high_priority(self, enabled: bool) -> Self

Enable or disable high-priority checkpointing.

pub fn validate(&self) -> Result<(), String>

Validate the configuration.

Returns an error if any configuration parameters are invalid.

Trait Implementations

impl Clone for EngineConfig

fn clone(&self) -> EngineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineConfig

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

Formats the value using the given formatter.

impl Default for EngineConfig

fn default() -> Self

Returns the “default value” for a type.