Struct extism_runtime::PluginMemory

pub struct PluginMemory {
    pub store: Option<Store<Internal>>,
    pub memory: Memory,
    pub live_blocks: BTreeMap<usize, usize>,
    pub free: Vec<MemoryBlock>,
    pub position: usize,
    pub manifest: Manifest,
}

Handles memory for plugins

Fields

store: Option<Store<Internal>>

wasmtime Store

memory: Memory

WASM memory

live_blocks: BTreeMap<usize, usize>

Tracks allocated blocks

free: Vec<MemoryBlock>

Tracks free blocks

position: usize

Tracks current offset in memory

manifest: Manifest

Extism manifest

Implementations

impl PluginMemory

pub fn new(store: Store<Internal>, memory: Memory, manifest: Manifest) -> Self

Create memory for a plugin

pub fn store(&self) -> &Store<Internal>

pub fn store_mut(&mut self) -> &mut Store<Internal>

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

Moves module to a new store

pub fn write( &mut self, pos: impl ToMemoryBlock, data: impl AsRef<[u8]> ) -> Result<(), Error>

Write slice to memory

pub fn read( &self, pos: impl ToMemoryBlock, data: impl AsMut<[u8]> ) -> Result<(), Error>

Read slice from memory

pub fn size(&self) -> usize

Size of memory in bytes

pub fn pages(&self) -> u32

Size of memory in pages

pub fn alloc(&mut self, n: usize) -> Result<MemoryBlock, Error>

Reserve n bytes of memory

pub fn alloc_bytes( &mut self, data: impl AsRef<[u8]> ) -> Result<MemoryBlock, Error>

Allocate and copy data into the wasm memory

pub fn free(&mut self, offset: usize)

Free the block allocated at offset

pub fn dump(&self)

Log entire memory as hexdump using the trace log level

pub fn reset(&mut self)

Reset memory - clears free-list and live blocks and resets position

pub fn data(&self) -> &[u8]

Get memory as a slice of bytes

pub fn data_mut(&mut self) -> &mut [u8]

Get memory as a mutable slice of bytes

pub fn get(&self, handle: impl ToMemoryBlock) -> Result<&[u8], Error>

Get bytes occupied by the provided memory handle

pub fn get_mut( &mut self, handle: impl ToMemoryBlock ) -> Result<&mut [u8], Error>

Get mutable bytes occupied by the provided memory handle

pub fn get_str(&self, handle: impl ToMemoryBlock) -> Result<&str, Error>

Get str occupied by the provided memory handle

pub fn get_mut_str( &mut self, handle: impl ToMemoryBlock ) -> Result<&mut str, Error>

Get mutable str occupied by the provided memory handle

pub fn ptr(&self, handle: impl ToMemoryBlock) -> Result<*mut u8, Error>

Pointer to the provided memory handle

pub fn block_length(&self, offs: usize) -> Option<usize>

Get the length of the block starting at offs

pub fn at_offset(&self, offset: usize) -> Option<MemoryBlock>

Get the block at the specified offset