Struct MemoryMappedVmo 

pub struct MemoryMappedVmo<const WRITABLE: bool> { /* private fields */ }

Memory-maps a VMO and mediates access to its memory.

Implementations

impl<const WRITABLE: bool> MemoryMappedVmo<WRITABLE>

pub unsafe fn new(vmo: &Vmo) -> Result<Self, Status>

Maps a VMO into memory (read-only if WRITABLE is false, read-write if WRITABLE is true).

Safety

The caller must either guarantee that the VMO is not modified by others while the returned instance is alive or that accesses are synchronized in application-specific ways.

pub fn vmo_size(&self) -> usize

Returns the number of usable bytes in the VMO (i.e. its ZX_PROP_VMO_CONTENT_SIZE property, which is not rounded to the page size).

pub fn get_slice<'a, T: FromBytes>( &'a self, byte_offset: usize, num_elements: usize, ) -> Result<&'a [T], Error>

Returns a reference to a slice of elements in the VMO.

This method validates the alignment and the bounds against the VMO size.

pub fn get_object<'a, T: FromBytes>( &'a self, byte_offset: usize, ) -> Result<&'a T, Error>

Returns a reference to an element in the VMO.

This method validates the alignment and the bounds against the VMO size.

impl MemoryMappedVmo<true>

pub fn get_slice_mut<'a, T: FromBytes>( &'a mut self, byte_offset: usize, num_elements: usize, ) -> Result<&'a mut [T], Error>

Returns a mutable reference to a slice of elements in the VMO.

This method validates the alignment and the bounds against the VMO size.

pub fn get_object_mut<'a, T: FromBytes>( &'a mut self, byte_offset: usize, ) -> Result<&'a mut T, Error>

Returns a mutable reference to an element in the VMO.

This method validates the alignment and the bounds against the VMO size.

pub fn into_readonly(self) -> MemoryMappedVmo<false>

Downgrades a read-write mapping handle into a read-only mapping handle without unmapping.

Trait Implementations

impl Deref for MemoryMappedVmo<true>

type Target = MemoryMappedVmo<false>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const WRITABLE: bool> Drop for MemoryMappedVmo<WRITABLE>

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.