Struct FileStorage 

pub struct FileStorage { /* private fields */ }

A file-based storage implementation.

FileStorage provides persistent disk-based storage with two read modes:

1. Traditional I/O (default): Uses buffered file reads with BufReader
2. Memory-mapped I/O: Uses mmap for zero-copy reads when config.use_mmap is true

The mmap mode includes caching and automatic invalidation on file changes, making it suitable for read-heavy workloads with large files.

Implementations

impl FileStorage

pub fn new<P: AsRef<Path>>( directory: P, config: FileStorageConfig, ) -> Result<Self>

Create a new file storage in the given directory.

Trait Implementations

impl Debug for FileStorage

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

Formats the value using the given formatter.

impl Storage for FileStorage

fn loading_mode(&self) -> LoadingMode

Get the preferred loading mode for this storage.

fn open_input(&self, name: &str) -> Result<Box<dyn StorageInput>>

Open a file for reading.

fn create_output(&self, name: &str) -> Result<Box<dyn StorageOutput>>

Create a file for writing.

fn create_output_append(&self, name: &str) -> Result<Box<dyn StorageOutput>>

Create a file for appending.

fn file_exists(&self, name: &str) -> bool

Check if a file exists.

fn delete_file(&self, name: &str) -> Result<()>

Delete a file.

fn list_files(&self) -> Result<Vec<String>>

List all files in the storage.

fn file_size(&self, name: &str) -> Result<u64>

Get the size of a file in bytes.

fn metadata(&self, name: &str) -> Result<FileMetadata>

Get file metadata.

fn rename_file(&self, old_name: &str, new_name: &str) -> Result<()>

Rename a file.

fn create_temp_output( &self, prefix: &str, ) -> Result<(String, Box<dyn StorageOutput>)>

Create a temporary file.

fn sync(&self) -> Result<()>

Sync all pending writes to storage.

fn close(&mut self) -> Result<()>

Close the storage and release resources.