Struct Memory 

pub struct Memory(/* private fields */);

A memory instance in a store.

Example

use tinywasm::types::MemoryType;
use tinywasm::{Memory, Store};

let mut store = Store::default();
let memory = Memory::new(&mut store, MemoryType::default().with_page_count_initial(1))?;

memory.copy_from_slice(&mut store, 0, b"hi")?;
assert_eq!(memory.read_vec(&store, 0, 2)?, b"hi");
assert_eq!(memory.page_count(&store)?, 1);
memory.grow(&mut store, 1)?;
assert_eq!(memory.page_count(&store)?, 2);

Implementations

impl Memory

pub fn new(store: &mut Store, ty: MemoryType) -> Result<Self>

Create a new memory in the given store.

pub fn cursor<'a>(&self, store: &'a mut Store) -> Result<MemoryCursor<'a>>

Available on crate feature std only.

Creates a cursor positioned at the start of this memory.

Available with the std feature enabled.

pub fn cursor_at<'a>( &self, store: &'a mut Store, position: u64, ) -> Result<MemoryCursor<'a>>

Available on crate feature std only.

Creates a cursor positioned at position bytes from the start of this memory.

Available with the std feature enabled.

pub fn len(&self, store: &Store) -> Result<usize>

Returns the raw memory byte length.

pub fn ty(&self, store: &Store) -> Result<MemoryType>

Returns the memory type, including page size and limits.

pub fn read( &self, store: &Store, offset: usize, dst: &mut [u8], ) -> Result<usize>

Reads up to dst.len() bytes from memory and returns the number of bytes read.

Depending on the configured backend, this may return fewer bytes than requested even when more data is available. Use Self::read_exact or Self::read_vec when you need a full range.

pub fn write( &self, store: &mut Store, offset: usize, src: &[u8], ) -> Result<usize>

Writes up to src.len() bytes into memory and returns the number of bytes written.

Depending on the configured backend, this may return fewer bytes than requested even when more space is available. Use Self::copy_from_slice when you need the full slice written.

pub fn read_exact( &self, store: &Store, offset: usize, dst: &mut [u8], ) -> Result<()>

Reads exactly dst.len() bytes from memory.

pub fn read_vec( &self, store: &Store, offset: usize, len: usize, ) -> Result<Vec<u8>>

Reads len bytes from memory into a newly allocated buffer.

pub fn grow(&self, store: &mut Store, delta_pages: i64) -> Result<Option<i64>>

Grow the memory by the given number of pages.

pub fn page_count(&self, store: &Store) -> Result<usize>

Get the current size of the memory in pages.

pub fn copy_within( &self, store: &mut Store, src: usize, dst: usize, len: usize, ) -> Result<()>

Copy a slice of memory to another place in memory.

pub fn fill( &self, store: &mut Store, offset: usize, len: usize, val: u8, ) -> Result<()>

Fill a slice of memory with a value.

pub fn copy_from_slice( &self, store: &mut Store, offset: usize, data: &[u8], ) -> Result<()>

Copies a full slice into memory.

pub fn write_cstring( &self, store: &mut Store, offset: usize, string: &CString, ) -> Result<()>

Copies a nul-terminated C string into memory.

pub fn write_cstring_bytes( &self, store: &mut Store, offset: usize, string: &str, ) -> Result<()>

Copies a UTF-8 string into memory and appends a trailing nul byte.

pub fn read_cstring( &self, store: &Store, offset: usize, len: usize, ) -> Result<CString>

Reads a C-style string from memory.

pub fn read_cstring_until_null( &self, store: &Store, offset: usize, max_len: usize, ) -> Result<CString>

Reads a C-style string from memory, stopping at the first null byte.

pub fn read_string( &self, store: &Store, offset: usize, len: usize, ) -> Result<String>

Reads a UTF-8 string from memory.

pub fn read_js_string( &self, store: &Store, offset: usize, len: usize, ) -> Result<String>

Reads a JavaScript-style utf-16 string from memory.

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Memory

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

Formats the value using the given formatter.

impl From<Memory> for Extern

fn from(value: Memory) -> Self

Converts to this type from the input type.

impl Hash for Memory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Memory

fn eq(&self, other: &Memory) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Memory

impl Eq for Memory

impl StructuralPartialEq for Memory