Struct SharedMemory

pub struct SharedMemory { /* private fields */ }

A handle that exposes operations only relevant for shared memories.

Enables interaction independent from the crate::Store, and thus allows calling some methods an instane is running.

NOTE: Not all methods are supported by all backends.

Implementations

impl SharedMemory

pub fn memory(&self) -> &Memory

Get the underlying memory.

pub fn notify( &self, location: MemoryLocation, count: u32, ) -> Result<u32, AtomicsError>

Notify up to count waiters waiting for the memory location.

pub fn wait( &self, location: MemoryLocation, timeout: Option<Duration>, ) -> Result<u32, AtomicsError>

Wait for the memory location to be notified.

pub fn disable_atomics(&self) -> Result<(), MemoryError>

Disable atomics for this memory.

All subsequent atomic wait calls will produce a trap.

This can be used or forced shutdown of instances that continuously try to wait on atomics.

NOTE: this operation might not be supported by all memory implementations. In that case, this function will return an error.

pub fn wake_all_atomic_waiters(&self) -> Result<(), MemoryError>

Wake up all atomic waiters.

This can be used to force-resume waiting execution.

NOTE: this operation might not be supported by all memory implementations. In that case, this function will return an error.

Trait Implementations

impl Clone for SharedMemory

fn clone(&self) -> SharedMemory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedMemory

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

Formats the value using the given formatter.