Struct wasmedge_sdk::Memory

source ·

pub struct Memory { /* private fields */ }

Expand description

Defines a linear memory.

Implementations§

source §

impl Memory

source

pub fn new(ty: MemoryType) -> WasmEdgeResult<Self>

Creates a new wasm memory instance with the given type.

Argument

ty - The type of the memory instance to be created.

Error

If fail to create the memory instance, then WasmEdgeError::Mem(MemError::Create) is returned.

source

pub fn name(&self) -> Option<&str>

Returns the exported name of this memory.

Notice that this field is meaningful only if this memory is used as an exported instance.

source

pub fn mod_name(&self) -> Option<&str>

Returns the name of the module instance from which this memory exports.

Notice that this field is meaningful only if this memory is used as an exported instance.

source

pub fn ty(&self) -> &MemoryType

Returns a reference to the type of this memory.

source

pub fn page(&self) -> u32

Returns the size, in WebAssembly pages (64 KiB of each page), of this wasm memory.

source

pub fn size(&self) -> u64

Returns the byte length of this memory. The returned value will be a multiple of the wasm page size, 64k.

source

pub fn read(&self, offset: u32, len: u32) -> WasmEdgeResult<Vec<u8>>

Safely reads memory contents at the given offset into a buffer.

Arguments

offset - The offset from which to read.
len - the length of bytes to read.

Error

If fail to read the memory, then an error is returned.

source

pub fn read_string(&self, offset: u32, len: u32) -> WasmEdgeResult<String>

Returns a string of byte length len from this memory, starting at offset.

Arguments

offset - The offset from which to read.
len - the length of bytes to read.

Error

If fail to read, then an error is returned.

source

pub fn write(&mut self, data: impl AsRef<[u8]>, offset: u32) -> WasmEdgeResult<()>

Safely writes contents of a buffer to this memory at the given offset.

Arguments

data - The bytes to write to this memory..
offset - The offset at which to write.

Error

If fail to write to the memory, then an error is returned.

source

pub fn grow(&mut self, count: u32) -> WasmEdgeResult<()>

Grows this memory by the count pages.

Argument

count - The number of pages to grow the memory by.

Error

If fail to grow the memory, then an error is returned.

source

pub fn data_pointer(&self, offset: u32, len: u32) -> WasmEdgeResult<*const u8>

Returns the const data pointer to this memory.

Arguments

offset - The data start offset in this memory.
len - The requested data length. If the size of offset + len is larger than the data size in this memory.

Errors

If fail to get the data pointer, then an error is returned.

source

pub fn data_pointer_mut(
 &mut self,
 offset: u32,
 len: u32
) -> WasmEdgeResult<*mut u8>

Returns the data pointer to this memory.

Arguments

offset - The data start offset in this memory.
len - The requested data length. If the size of offset + len is larger than the data size in this memory.