Struct wasmer_vm::mmap::Mmap

source ·
pub struct Mmap {
    ptr: usize,
    total_size: usize,
    accessible_size: usize,
    sync_on_drop: bool,
}
Expand description

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

Fields§

§ptr: usize§total_size: usize§accessible_size: usize§sync_on_drop: bool

Implementations§

source§

impl Mmap

source

pub fn new() -> Self

Construct a new empty instance of Mmap.

source

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.

source

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

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.

source

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

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.

source

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

Return the allocated memory as a slice of u8.

source

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

Return the allocated memory as a slice of u8.

source

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

Return the allocated memory as a slice of u8.

source

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

Return the allocated memory as a mutable slice of u8.

source

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

Return the allocated memory as a mutable slice of u8.

source

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

Return the allocated memory as a mutable slice of u8.

source

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

Return the allocated memory as a pointer to u8.

source

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

Return the allocated memory as a mutable pointer to u8.

source

pub fn len(&self) -> usize

Return the length of the allocated memory.

source

pub fn is_empty(&self) -> bool

Return whether any memory has been allocated.

source

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

👎Deprecated: use copy instead

Duplicate in a new memory mapping.

source

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

Duplicate in a new memory mapping.

Trait Implementations§

source§

impl Debug for Mmap

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for Mmap

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Mmap

§

impl RefUnwindSafe for Mmap

§

impl Send for Mmap

§

impl Sync for Mmap

§

impl Unpin for Mmap

§

impl UnwindSafe for Mmap

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.