Struct wasmi::MemoryRef

use wasmi::MemoryInstance;
use wasmi::memory_units::*;

let memory = MemoryInstance::alloc(Pages(1), None).unwrap();
let byte_size: Bytes = memory.current_size().into();
assert_eq!(
    byte_size,
    Bytes(65536),
);

source

pub fn get_value<T: LittleEndianConvert>(&self, offset: u32) -> Result<T, Error>

Get value from memory at given offset.

source

pub fn get(&self, offset: u32, size: usize) -> Result<Vec<u8>, Error>

Copy data from memory at given offset.

This will allocate vector for you. If you can provide a mutable slice you can use get_into.

source

pub fn get_into(&self, offset: u32, target: &mut [u8 ]) -> Result<(), Error>

Copy data from given offset in the memory into target slice.

Errors

Returns Err if the specified region is out of bounds.

source

pub fn set(&self, offset: u32, value: &[u8 ]) -> Result<(), Error>

Copy data in the memory at given offset.

source

pub fn set_value<T: LittleEndianConvert>(
 &self,
 offset: u32,
 value: T
) -> Result<(), Error>

Copy value in the memory at given offset.

source

pub fn grow(&self, additional: Pages) -> Result<Pages, Error>

Increases the size of the linear memory by given number of pages. Returns previous memory size if succeeds.

Errors

Returns Err if attempted to allocate more memory than permited by the limit.

source

pub fn copy(
 &self,
 src_offset: usize,
 dst_offset: usize,
 len: usize
) -> Result<(), Error>

Copy contents of one memory region to another.

Semantically equivalent to memmove.

Errors

Returns Err if either of specified regions is out of bounds.

source

pub fn copy_nonoverlapping(
 &self,
 src_offset: usize,
 dst_offset: usize,
 len: usize
) -> Result<(), Error>

Copy contents of one memory region to another (non-overlapping version).

Semantically equivalent to memcpy. but returns Error if source overlaping with destination.

Errors

Returns Err if:

either of specified regions is out of bounds,
these regions overlaps.

source

pub fn clear(&self, offset: usize, new_val: u8, len: usize) -> Result<(), Error>

Fill the memory region with the specified value.

Semantically equivalent to memset.

Errors

Returns Err if the specified region is out of bounds.

source

pub fn zero(&self, offset: usize, len: usize) -> Result<(), Error>

Fill the specified memory region with zeroes.

Errors

Returns Err if the specified region is out of bounds.

source

pub fn erase(&self) -> Result<(), Error>

Set every byte in the entire linear memory to 0, preserving its size.

Might be useful for some optimization shenanigans.

source

pub fn with_direct_access<R, F: FnOnce(&[u8 ]) -> R>(&self, f: F) -> R

Provides direct access to the underlying memory buffer.

Panics

Any call that requires write access to memory (such as set, clear, etc) made within the closure will panic.

source

pub fn with_direct_access_mut<R, F: FnOnce(&mut [u8 ]) -> R>(&self, f: F) -> R

Provides direct mutable access to the underlying memory buffer.

Panics

Any calls that requires either read or write access to memory (such as get, set, [copy], etc) made within the closure will panic. Proceed with caution.