Struct wasmtime_runtime::Memory

pub struct Memory { /* fields omitted */ }

Represents an instantiation of a WebAssembly memory.

Implementations

impl Memory

pub fn new_dynamic(
    plan: &MemoryPlan,
    creator: &dyn RuntimeMemoryCreator,
    limiter: Option<&Rc<dyn ResourceLimiter>>
) -> Result<Self>

Create a new dynamic (movable) memory instance for the specified plan.

pub fn new_static(
    plan: &MemoryPlan,
    base: *mut u8,
    maximum: u32,
    make_accessible: fn(_: *mut u8, _: usize) -> Result<()>,
    limiter: Option<&Rc<dyn ResourceLimiter>>
) -> Result<Self>

Create a new static (immovable) memory instance for the specified plan.

pub fn size(&self) -> u32

Returns the number of allocated wasm pages.

pub fn maximum(&self) -> Option<u32>

Returns the maximum number of pages the memory can grow to at runtime.

Returns None if the memory is unbounded.

The runtime maximum may not be equal to the maximum from the linear memory’s Wasm type when it is being constrained by an instance allocator.

pub unsafe fn grow(&self, delta: u32) -> Option<u32>

Grow memory by the specified amount of wasm pages.

Returns None if memory can’t be grown by the specified amount of wasm pages.

Safety

Resizing the memory can reallocate the memory buffer for dynamic memories. An instance’s VMContext may have pointers to the memory’s base and will need to be fixed up after growing the memory.

Generally, prefer using InstanceHandle::memory_grow, which encapsulates this unsafety.

pub fn vmmemory(&self) -> VMMemoryDefinition

Return a VMMemoryDefinition for exposing the memory to compiled wasm code.

Trait Implementations

impl Default for Memory

fn default() -> Self

Returns the “default value” for a type.