Struct mmap_safe::MappedFile

pub struct MappedFile { /* private fields */ }

A thin, safe wrapper for memory-mapped files.

This wrapper ensures memory safety by only providing one mutable reference at a time and by locking the file exclusively.

Implementations

impl MappedFile

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

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

pub fn new(file: File) -> Result<Self>

pub fn map(&self, offset: u64, size: usize) -> Result<Mapping<'_>>

Returns mapped memory for the file.

pub fn map_mut<'a>(
    &'a mut self,
    offset: u64,
    size: usize
) -> Result<MutMapping<'a>>

Returns mutably-mapped memory for the file.

pub fn resize(&mut self, size: u64) -> Result<()>

Resizes the file. When grown, it is guaranteed that all mapped memory regions on this file stay valid. When the file gets shrunk, the behaviour of regions behind the new end of the file is undefined.

pub fn size(&self) -> u64

Returns the current size of the file.

pub fn sync_data(&mut self) -> Result<()>

See File::sync_data

pub fn sync_all(&mut self) -> Result<()>

See File::sync_all

pub fn into_mut_mapping(
    self,
    offset: u64,
    size: usize
) -> Result<IntoMutMapping, (Error, Self)>

Converts this instance into a mutable mapping. If you want to convert it back, call IntoMutMapping::unmap.

Trait Implementations

impl Drop for MappedFile

fn drop(&mut self)

Executes the destructor for this type.