Struct MemoryMappedArcVmo 

pub struct MemoryMappedArcVmo<const WRITABLE: bool, M: Send + Sync = ()> { /* private fields */ }

Reference-counted MemoryMappedVmo backed by an auxiliary control VMO to store the reference count and, optionally, extra shared metadata.

Implementations

impl<const WRITABLE: bool, M: Send + Sync> MemoryMappedArcVmo<WRITABLE, M>

pub unsafe fn wrap( storage: MemoryMappedVmo<WRITABLE>, metadata: M, ) -> Result<Self, Status>

Wraps a MemoryMappedVmo into a MemoryMappedArcVmo with the given extra metadata.

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 unsafe fn wrap_with_name( storage: MemoryMappedVmo<WRITABLE>, metadata: M, control_vmo_name: &Name, ) -> Result<Self, Status>

Like wrap, but also sets the control VMO name.

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 metadata(&self) -> &M

Returns a shared reference to the metadata stored in the control block.

impl<M: Send + Sync> MemoryMappedArcVmo<true, M>

pub fn into_readonly(self) -> MemoryMappedArcVmo<false, M>

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

Methods from Deref<Target = MemoryMappedVmo<WRITABLE>>

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.

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.

Trait Implementations

impl<const WRITABLE: bool, M: Send + Sync> Clone for MemoryMappedArcVmo<WRITABLE, M>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const WRITABLE: bool, M: Send + Sync> Deref for MemoryMappedArcVmo<WRITABLE, M>

type Target = MemoryMappedVmo<WRITABLE>

The resulting type after dereferencing.

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

Dereferences the value.

impl<M: Send + Sync> DerefMut for MemoryMappedArcVmo<true, M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const WRITABLE: bool, M: Send + Sync> Drop for MemoryMappedArcVmo<WRITABLE, M>

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.