wasmtime::Memory Class Reference

A WebAssembly linear memory. More...

#include <wasmtime.hh>

Public Member Functions
	Memory (wasmtime_memory_t memory)
	Creates a new memory from the raw underlying C API representation.
MemoryType	type (Store::Context cx) const
	Returns the type of this memory.
uint64_t	size (Store::Context cx) const
	Returns the size, in WebAssembly pages, of this memory.
Span< uint8_t >	data (Store::Context cx) const
Result< uint64_t >	grow (Store::Context cx, uint64_t delta) const

Static Public Member Functions
static Result< Memory >	create (Store::Context cx, const MemoryType &ty)
	Creates a new host-defined memory with the type specified.

Detailed Description

A WebAssembly linear memory.

This class represents a WebAssembly memory, either created through instantiating a module or a host memory.

Note that this type does not itself own any resources. It points to resources owned within a Store and the Store must be passed in as the first argument to the functions defined on Table. Note that if the wrong Store is passed in then the process will be aborted.

Examples

memory.cc.

Member Function Documentation

data()

Span< uint8_t > wasmtime::Memory::data ( Store::Context  cx ) const

inline

Returns a span of where this memory is located in the host.

Note that embedders need to be very careful in their usage of the returned span. It can be invalidated with calls to grow and/or calls into WebAssembly.

grow()

Result< uint64_t > wasmtime::Memory::grow ( Store::Context  cx, uint64_t  delta  ) const

inline

Grows the memory by delta WebAssembly pages.

On success returns the previous size of this memory in units of WebAssembly pages.

Examples

memory.cc.

---

The documentation for this class was generated from the following file:

• include/wasmtime.hh