Struct Mmap 

pub struct Mmap { /* private fields */ }

A memory mapping that was mapped application using mmap. munmap is automatically called when the object is dropped.

Invariants

The address in mem must be a multiple of the PAGE_SIZE and of the mapping’s huge page size if the mapping employs huge pages.

mem’s length must not be zero.

Implementations

impl Mmap

pub unsafe fn from_raw(mem: *mut [u8]) -> Self

Creates a new Mmap object from a slice that was mapped with mmap.

Safety

The address in mem must be a multiple of the PAGE_SIZE and of the mapping’s huge page size if the mapping employs huge pages.

mem’s length must not be zero.

pub unsafe fn split_at(self, offset: usize) -> (Self, Self)

Splits the memory mapping into two sub-mappings:

1. from zero included to offset excluded, and
2. from offset included to the end.

Safety

offset must be a multiple of the PAGE_SIZE and of the mapping’s huge page size if the mapping employs huge pages.

offset must not be zero or be larger than or equal to the mapping’s size as empty (sub-)mappings are invalid according to Mmap’s invariants.

pub fn into_raw(self) -> *mut [u8]

Consumes the Mmap, returning a wrapped raw pointer.

After calling this function, the caller is responsible for the memory mapping.

Trait Implementations

impl AsMut<[u8]> for Mmap

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Mmap

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Drop for Mmap

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Mmap

impl Sync for Mmap