Struct Config 

pub struct Config {
    pub page_size: usize,
    pub buffer_pool_pages: usize,
    pub path: PathBuf,
    pub create_if_missing: bool,
    pub enable_wal: bool,
    pub sync_on_commit: bool,
    pub encryption: EncryptionConfig,
    pub wal_config: WalGroupCommitConfig,
    pub compression: CompressionConfig,
    pub eviction_policy: EvictionPolicyType,
    pub storage_limits: StorageLimitsConfig,
    pub api_key: Option<String>,
}

Database configuration options

Fields

page_size: usize

Page size in bytes (default: 4096)

buffer_pool_pages: usize

Buffer pool size in pages (default: 16384 = 64MB with 4KB pages)

path: PathBuf

Path to the database file

create_if_missing: bool

Create database if it doesn’t exist

enable_wal: bool

Enable WAL for durability

sync_on_commit: bool

Sync data file on every commit for durability (default: true) Set to false for benchmarks or applications that prioritize speed over durability

encryption: EncryptionConfig

Encryption configuration

wal_config: WalGroupCommitConfig

WAL group commit configuration

compression: CompressionConfig

Compression configuration

eviction_policy: EvictionPolicyType

Buffer pool eviction policy (default: Clock)

storage_limits: StorageLimitsConfig

Storage limits configuration

api_key: Option<String>

API key for authentication (v0.3.5)

Implementations

impl Config

pub fn new<P: Into<PathBuf>>(path: P) -> Self

pub fn page_size(self, size: usize) -> Self

pub fn buffer_pool_size_mb(self, mb: usize) -> Self

pub fn create_if_missing(self, create: bool) -> Self

pub fn with_sync_on_commit(self, sync: bool) -> Self

Set whether to sync the data file on every commit (default: true)

When false, committed data may be lost on crash but write operations are significantly faster. Useful for benchmarks and non-critical data.

pub fn with_password<S: Into<String>>(self, password: S) -> Self

Enable password-based encryption

pub fn with_key(self, key: [u8; 32]) -> Self

Enable encryption with a raw key

pub fn is_encrypted(&self) -> bool

Check if encryption is enabled

pub fn wal_config(self, config: WalGroupCommitConfig) -> Self

Set WAL configuration for group commit

pub fn with_group_commit(self) -> Self

Enable group commit mode for improved throughput

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

Set group commit interval in milliseconds

pub fn group_commit_max_batch(self, max: usize) -> Self

Set maximum batch size for group commit

pub fn with_compression(self, compression: CompressionConfig) -> Self

Set compression configuration

pub fn with_lz4_compression(self) -> Self

Enable LZ4 compression (fast)

pub fn with_zstd_compression(self) -> Self

Enable ZSTD compression with default level

pub fn with_zstd_compression_level(self, level: i32) -> Self

Enable ZSTD compression with specified level (1-22)

pub fn compression_threshold(self, threshold: usize) -> Self

Set the compression threshold (minimum size to compress)

pub fn is_compressed(&self) -> bool

Check if compression is enabled

pub fn with_eviction_policy(self, policy: EvictionPolicyType) -> Self

Set the buffer pool eviction policy

Example

use featherdb_core::{Config, EvictionPolicyType};

let config = Config::new("mydb.db")
    .with_eviction_policy(EvictionPolicyType::Lru2);

pub fn with_lru2_eviction(self) -> Self

Use LRU-2 eviction policy (5-15% higher cache hit rate for mixed workloads)

pub fn with_lirs_eviction(self) -> Self

Use LIRS eviction policy (best for varying access patterns)

pub fn with_clock_eviction(self) -> Self

Use Clock eviction policy (simple and fast, default)

pub fn with_storage_limits(self, config: StorageLimitsConfig) -> Self

Set storage limits configuration

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

Set maximum database file size in bytes

pub fn with_max_database_size_mb(self, mb: u64) -> Self

Set maximum database file size in megabytes

pub fn with_api_key<S: Into<String>>(self, key: S) -> Self

Set the API key for authentication

If the database requires authentication, provide the API key here. Keys are in the format fdb_<base64>.

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

Validate the database configuration

Validation Rules

• page_size: must be a power of 2 between 512 bytes and 64KB
• buffer_pool_pages: must be at least 16 pages
• wal_config: must pass validation
• compression: must pass validation

Errors

Returns ConfigError if validation fails

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.