Struct Mmap 

pub struct Mmap { /* private fields */ }

A handle to a memory mapped region.

The region is automatically unmapped when this handle is dropped.

Implementations

impl Mmap

pub const fn ptr(&self) -> *mut u8

Returns a pointer to the start of the memory mapping.

pub const fn len(&self) -> usize

Returns the length of the memory mapping in bytes.

pub const fn is_empty(&self) -> bool

Returns true if the memory mapping has length 0.

pub const fn into_raw(self) -> (*mut u8, usize)

Flushes the memory mapped region to disk (if file backed) or ensures visibility. For anonymous mappings, this is generally a no-op or ensures cache coherence.

Errors

Returns an error if the underlying system call fails. Currently for anonymous memory this always succeeds. Requires sys_alloc to expose from_raw parts or similar. Since Mmap wraps os::MmapInner, we need os::MmapInner to support this too or just handle it here.

Consumes the Mmap and returns the raw pointer and length. The memory will won’t be unmapped when this struct is dropped. The caller is responsible for cleaning up the memory, e.g. by creating a new Mmap with from_raw and dropping it.

pub const unsafe fn from_raw(ptr: *mut u8, len: usize) -> Self

Creates a Mmap from a raw pointer and length.

Safety

The pointer and length must have come from a previous call to into_raw. The memory must be valid and unchanged.

Trait Implementations

impl Send for Mmap

impl Sync for Mmap