Struct MmapFile 

pub struct MmapFile { /* private fields */ }

Implementations

impl MmapFile

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

Memory-map a file for reading using raw syscalls

pub fn new_mut(file: File, len: usize) -> Result<Self>

Memory-map a file for read-write using raw syscalls

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

Get slice view of mapped memory

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

Get mutable slice view (only if writable)

pub fn read_u32(&self, offset: usize) -> Result<u32>

Read u32 at offset

pub fn read_bytes(&self, offset: usize, len: usize) -> Result<&[u8]>

Read bytes at offset

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

Write bytes at offset

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

Read struct at offset (zero-copy)

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

Read mutable struct at offset (zero-copy)

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

Flush changes to disk (sync)

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

Flush changes to disk (async)

pub fn advise(&self, advice: MadviseAdvice) -> Result<()>

Advise kernel about access pattern

pub fn len(&self) -> usize

Get size of mapped region

pub fn is_empty(&self) -> bool

Check if empty

Trait Implementations

impl Drop for MmapFile

Available on Linux only.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.