Struct FileMapState 

pub struct FileMapState { /* private fields */ }

Struct to manage memory range mapped from file objects.

It maps a region from a file into current process by using libc::mmap(). Then it provides safe interfaces to access the memory mapped region.

Implementations

impl FileMapState

pub fn new( file: File, offset: off_t, size: usize, writable: bool, ) -> Result<Self>

Memory map a region of the file object into current process.

It takes ownership of the file object and will close it when the returned object is dropped.

pub fn size(&self) -> usize

Get size of mapped region.

pub fn get_ref<T>(&self, offset: usize) -> Result<&T>

Cast a subregion of the mapped area to an object reference.

pub fn get_mut<T>(&mut self, offset: usize) -> Result<&mut T>

Cast a subregion of the mapped area to an mutable object reference.

pub fn get_slice<T>(&self, offset: usize, count: usize) -> Result<&[T]>

Get an immutable slice of ‘T’ at ‘offset’ with ‘count’ entries.

pub fn get_slice_mut<T>( &mut self, offset: usize, count: usize, ) -> Result<&mut [T]>

Get a mutable slice of ‘T’ at ‘offset’ with ‘count’ entries.

pub fn validate_range(&self, offset: usize, size: usize) -> Result<*const u8>

Check whether the range [offset, offset + size) is valid and return the start address.

pub unsafe fn offset(&self, offset: usize) -> *const u8

Add offset to the base pointer.

Safety

The caller should ensure that offset is within range.

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

Sync mapped file data into disk.

Trait Implementations

impl Default for FileMapState

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FileMapState

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FileMapState

impl Sync for FileMapState