Struct FileStorageConfig 

pub struct FileStorageConfig {
    pub path: PathBuf,
    pub use_mmap: bool,
    pub buffer_size: usize,
    pub sync_writes: bool,
    pub use_locking: bool,
    pub temp_dir: Option<String>,
    pub mmap_cache_size: usize,
    pub mmap_enable_prefault: bool,
    pub mmap_enable_hugepages: bool,
}

Configuration specific to file-based storage.

This configuration includes the storage path and various options for file I/O, memory-mapping, and locking behavior.

Memory-Mapped Files (mmap)

When use_mmap is enabled, FileStorage uses memory-mapped I/O for reading files, which can significantly improve performance for large files by:

• Avoiding system call overhead
• Leveraging the OS page cache
• Enabling zero-copy reads

Additional mmap options:

• mmap_cache_size: Number of mmap files to keep cached
• mmap_enable_prefault: Pre-populate page tables for faster initial access
• mmap_enable_hugepages: Use huge pages if available (Linux)

Example

use laurus::storage::file::FileStorageConfig;

// Basic file storage
let config = FileStorageConfig::new("/data/index");

// High-performance configuration with mmap
let mut config = FileStorageConfig::new("/data/index");
config.use_mmap = true;
config.mmap_enable_prefault = true;
config.buffer_size = 131072; // 128KB for non-mmap operations

Fields

path: PathBuf

Path to the storage directory.

use_mmap: bool

Whether to use memory-mapped files for reading. When true, files are read using mmap instead of traditional I/O.

buffer_size: usize

Buffer size for traditional I/O operations (bytes). Default: 65536 (64KB). Used when use_mmap is false.

sync_writes: bool

Whether to sync writes immediately to disk. When true, calls fsync after each write for durability.

use_locking: bool

Whether to use file locking for concurrency control.

temp_dir: Option<String>

Temporary directory for temp files. If None, uses the storage directory.

mmap_cache_size: usize

Maximum number of memory-mapped files to cache. Only used when use_mmap is true. Default: 100.

mmap_enable_prefault: bool

Enable prefaulting for memory-mapped files. Pre-populates page tables for faster initial access. Only used when use_mmap is true.

mmap_enable_hugepages: bool

Enable huge pages for memory-mapped files if available. Can improve TLB performance for large files (Linux only). Only used when use_mmap is true.

Note: This field is currently a placeholder and is not yet used by the get_mmap() implementation. Setting it has no effect at this time.

Implementations

impl FileStorageConfig

pub fn new<P: AsRef<Path>>(path: P) -> Self

Create a new FileStorageConfig with the given path and default settings.

Default Settings

• use_mmap: false
• buffer_size: 65536 (64KB)
• sync_writes: false
• use_locking: true
• mmap_cache_size: 100
• mmap_enable_prefault: false
• mmap_enable_hugepages: false

Trait Implementations

impl Clone for FileStorageConfig

fn clone(&self) -> FileStorageConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileStorageConfig

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

Formats the value using the given formatter.