Struct StoreBuilder

pub struct StoreBuilder { /* private fields */ }

Builder for creating FeoxStore with custom configuration.

Provides a fluent interface for configuring store parameters.

Example

use feoxdb::FeoxStore;

let store = FeoxStore::builder()
    .max_memory(1_000_000_000)
    .hash_bits(20)
    .enable_ttl(true)
    .build()?;

Implementations

impl StoreBuilder

pub fn new() -> Self

pub fn device_path(self, path: impl Into<String>) -> Self

Set the device path for persistent storage.

When set, data will be persisted to disk asynchronously. If not set, the store operates in memory-only mode.

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

Set the initial file size for new persistent stores (in bytes).

When creating a new persistent store file, it will be pre-allocated to this size for better performance. If not set, defaults to 1GB. This option is ignored for existing files.

Example

use feoxdb::FeoxStore;

let store = FeoxStore::builder()
    .device_path("/path/to/data.feox")
    .file_size(10 * 1024 * 1024 * 1024)  // 10GB
    .build()?;

pub fn max_memory(self, limit: usize) -> Self

Set the maximum memory limit (in bytes).

The store will start evicting entries when this limit is approached. Default: 1GB

pub fn no_memory_limit(self) -> Self

Remove memory limit.

Use with caution as the store can grow unbounded.

pub fn hash_bits(self, bits: u32) -> Self

Set number of hash bits (determines hash table size).

More bits = larger hash table = better performance for large datasets. Default: 18 (256K buckets)

pub fn enable_caching(self, enable: bool) -> Self

Enable or disable caching.

When enabled, frequently accessed values are kept in memory even after being written to disk. Uses CLOCK eviction algorithm.

pub fn enable_ttl(self, enable: bool) -> Self

Enable or disable TTL (Time-To-Live) functionality.

When disabled (default), TTL operations will return errors and no background cleaner runs. When enabled, keys can have expiry times and a background cleaner removes expired keys. Default: false (disabled for optimal performance)

pub fn enable_ttl_cleaner(self, enable: bool) -> Self

Enable or disable TTL sweeper.

When enabled, a background thread periodically removes expired keys. Note: This method is deprecated in favor of enable_ttl().

pub fn ttl_sweeper_config( self, sample_size: usize, threshold: f32, max_time_ms: u64, interval_ms: u64, ) -> Self

Configure TTL sweeper with custom parameters.

Arguments

• sample_size - Keys to check per batch
• threshold - Continue if >threshold expired (0.0-1.0)
• max_time_ms - Max milliseconds per cleaning run
• interval_ms - Sleep between runs

pub fn build(self) -> Result<FeoxStore>

Build the FeoxStore

Trait Implementations

impl Default for StoreBuilder

fn default() -> Self

Returns the “default value” for a type.