Struct MmapFile 

pub struct MmapFile { /* private fields */ }

A file-backed memory map (read-only, read-write, or copy-on-write).

Implementations

impl MmapFile

pub fn open<P: AsRef<Path>>(path: P, config: MmapConfig) -> MmapResult<Self>

Opens an existing file with the provided configuration.

pub fn create<P: AsRef<Path>>( path: P, size: usize, config: MmapConfig, ) -> MmapResult<Self>

Creates (or truncates) a file to size and opens a read-write mapping.

pub fn as_slice(&self) -> &[u8]

Returns a read-only view of the mapped bytes.

pub fn as_mut_slice(&mut self) -> Option<&mut [u8]>

Returns a mutable view of the bytes (if the mapping is writable).

pub fn len(&self) -> usize

Returns the mapped byte length.

pub fn is_empty(&self) -> bool

Returns true if the mapping length is zero.

pub fn is_writable(&self) -> bool

Returns true if the mapping mode allows writes.

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

Flushes any dirty pages (no-op for read-only maps).

pub fn flush_async(&self) -> MmapResult<()>

Flushes any dirty pages asynchronously (no-op for read-only maps).

pub fn flush_range(&self, offset: usize, len: usize) -> MmapResult<()>

Flushes a byte range (no-op for read-only maps).

pub fn access_archived<T>(&self) -> MmapResult<&T>

where T: Portable + for<'a> CheckBytes<HighValidator<'a, RkyvError>>,

Validates and returns an archived rkyv value from offset 0.

pub fn access_archived_at<T>(&self, offset: usize) -> MmapResult<&T>

where T: Portable + for<'a> CheckBytes<HighValidator<'a, RkyvError>>,

Validates and returns an archived rkyv value starting at offset.

pub fn as_ptr(&self) -> *const u8

Returns a raw pointer to the mapped bytes.

pub fn as_mut_ptr(&mut self) -> Option<*mut u8>

Returns a raw mutable pointer (if writable).

pub fn grow(&mut self, new_size: usize) -> MmapResult<()>

Grows the underlying file and remaps.

pub fn shrink(&mut self, new_size: usize) -> MmapResult<()>

Shrinks the underlying file and remaps.

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

Resizes the underlying file (grow/shrink) and remaps.

pub fn path(&self) -> &Path

Returns the file path.

pub fn mode(&self) -> MmapMode

Returns the mapping mode.