Struct mmap_wrapper::memmap2::MmapWrapper

pub struct MmapWrapper<T> { /* private fields */ }

A wrapper wrapper for a memory-mapped file with data of type T.

Safety

T must have a consistent memory layout to ensure that the data is casted correctly.

Use #[repr(transparent)] if T is a newtype wrapper around a single field otherwise #[repr(C)].

Example

use mmap_wrapper::MmapWrapper;

#[repr(C)]
struct MyStruct {
   thing1: i32,
   thing2: f64,
}

let f = std::fs::File::options()
    .read(true)
    .write(true)
    .create(true)
    .truncate(false)
    .open("/tmp/mystruct-mmap-test.bin")
    .unwrap();

let _ = f.set_len(std::mem::size_of::<MyStruct>() as u64);

let m = unsafe {
    memmap2::Mmap::map(&f).unwrap()
};

let m_wrapper = MmapWrapper::<MyStruct>::new(m);
let mmap_backed_mystruct = unsafe {
   m_wrapper.get_inner()
};

Implementations

impl<T> MmapWrapper<T>

pub fn new(m: Mmap) -> MmapWrapper<T>

pub fn make_mut(self) -> Result<MmapMutWrapper<T>, Error>

pub unsafe fn get_inner<'a>(&self) -> &'a T

Safety

the backing mmap pointer must point to valid memory for type T [T likely has to be repr(C)]

Trait Implementations

impl<T> From<Mmap> for MmapWrapper<T>

fn from(m: Mmap) -> MmapWrapper<T>

Converts to this type from the input type.