Struct MemoryMappedFile 

pub struct MemoryMappedFile { /* private fields */ }

Memory-mapped file wrapper providing cross-platform file access

Implementations

impl MemoryMappedFile

pub fn new(filepath: PathBuf, size: usize) -> SparseResult<Self>

Create a new memory-mapped file

pub fn new_with_config( filepath: PathBuf, size: usize, config: MemoryMappingConfig, ) -> SparseResult<Self>

Create memory-mapped file with configuration

pub fn open(filepath: PathBuf) -> SparseResult<Self>

Open existing memory-mapped file

pub fn read_at( &mut self, offset: usize, buffer: &mut [u8], ) -> SparseResult<usize>

Read data from the mapped file at offset

pub fn write_at(&mut self, offset: usize, data: &[u8]) -> SparseResult<usize>

Write data to the mapped file at offset

pub fn read_all(&mut self) -> SparseResult<Vec<u8>>

Read entire file contents

pub fn write_all(&mut self, data: &[u8]) -> SparseResult<()>

Write entire file contents

pub fn resize(&mut self, new_size: usize) -> SparseResult<()>

Resize the mapped file

pub fn flush(&self) -> SparseResult<()>

Flush data to disk

pub fn flush_data(&self) -> SparseResult<()>

Flush data to disk (metadata only)

pub fn size(&self) -> usize

Get file size

pub fn path(&self) -> &PathBuf

Get file path

pub fn is_mapped(&self) -> bool

Check if file is mapped

pub fn access_count(&self) -> u64

Get access count

pub fn reset_access_count(&mut self)

Reset access count

pub fn metadata(&self) -> SparseResult<Metadata>

Get file metadata

pub fn exists(&self) -> bool

Check if file exists

pub fn read_chunked<F>( &mut self, chunk_size: usize, callback: F, ) -> SparseResult<()>

where F: FnMut(&[u8], usize) -> SparseResult<()>,

Read data in chunks for better memory efficiency

pub fn write_chunked<F>( &mut self, chunk_size: usize, data_provider: F, ) -> SparseResult<()>

where F: FnMut(usize) -> SparseResult<Option<Vec<u8>>>,

Write data in chunks for better memory efficiency

pub fn prefetch(&self, offset: usize, length: usize) -> SparseResult<()>

Prefetch data into memory (hint to OS)

pub fn advise_access_pattern(&self, pattern: AccessPattern) -> SparseResult<()>

Advise access pattern to OS

Trait Implementations

impl Debug for MemoryMappedFile

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

Formats the value using the given formatter.