Struct Mmap

pub struct Mmap { /* private fields */ }

A simple struct consisting of a page-aligned pointer to page-aligned and initially-zeroed memory and a length.

Implementations

impl Mmap

pub fn new() -> Self

Construct a new empty instance of Mmap.

pub fn with_at_least(size: usize) -> Result<Self, String>

Create a new Mmap pointing to at least size bytes of page-aligned accessible memory.

pub fn accessible_reserved( accessible_size: usize, mapping_size: usize, backing_file: Option<PathBuf>, memory_type: MmapType, ) -> Result<Self, String>

Available on non-Windows only.

Create a new Mmap pointing to accessible_size bytes of page-aligned accessible memory, within a reserved mapping of mapping_size bytes. accessible_size and mapping_size must be native page-size multiples.

pub fn make_accessible( &mut self, start: usize, len: usize, ) -> Result<(), String>

Available on non-Windows only.

Make the memory starting at start and extending for len bytes accessible. start and len must be native page-size multiples and describe a range within self’s reserved memory.

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

Return the allocated memory as a slice of u8.

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

Return the allocated memory as a slice of u8.

pub fn as_slice_arbitary(&self, size: usize) -> &[u8]

Return the allocated memory as a slice of u8.

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

Return the allocated memory as a mutable slice of u8.

pub fn as_mut_slice_accessible(&mut self) -> &mut [u8]

Return the allocated memory as a mutable slice of u8.

pub fn as_mut_slice_arbitary(&mut self, size: usize) -> &mut [u8]

Return the allocated memory as a mutable slice of u8.

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

Return the allocated memory as a pointer to u8.

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

Return the allocated memory as a mutable pointer to u8.

pub fn len(&self) -> usize

Return the length of the allocated memory.

pub fn is_empty(&self) -> bool

Return whether any memory has been allocated.

pub fn duplicate(&mut self, size_hint: Option<usize>) -> Result<Self, String>

👎Deprecated: use copy instead

Duplicate in a new memory mapping.

pub fn copy(&mut self, size_hint: Option<usize>) -> Result<Self, String>

Duplicate in a new memory mapping.

Trait Implementations

impl Debug for Mmap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Mmap

fn drop(&mut self)

Executes the destructor for this type.