Enum BackendGlobal

pub(crate) enum BackendGlobal {
    Sys(Global),
}

Variants

Sys(Global)

The implementation from the sys backend.

Implementations

impl BackendGlobal

pub fn new(store: &mut impl AsStoreMut, val: Value) -> Self

Create a new global with the initial Value.

Example

let g = Global::new(&mut store, Value::I32(1));

assert_eq!(g.get(&mut store), Value::I32(1));
assert_eq!(g.ty(&mut store).mutability, Mutability::Const);

pub fn new_mut(store: &mut impl AsStoreMut, val: Value) -> Self

Create a mutable global with the initial Value.

Example

let g = Global::new_mut(&mut store, Value::I32(1));

assert_eq!(g.get(&mut store), Value::I32(1));
assert_eq!(g.ty(&mut store).mutability, Mutability::Var);

pub(crate) fn from_value( store: &mut impl AsStoreMut, val: Value, mutability: Mutability, ) -> Result<Self, RuntimeError>

Create a global with the initial Value and the provided Mutability.

pub fn ty(&self, store: &impl AsStoreRef) -> GlobalType

Returns the GlobalType of the global.

Example

let c = Global::new(&mut store, Value::I32(1));
let v = Global::new_mut(&mut store, Value::I64(1));

assert_eq!(c.ty(&mut store), GlobalType::new(Type::I32, Mutability::Const));
assert_eq!(v.ty(&mut store), GlobalType::new(Type::I64, Mutability::Var));

pub fn get(&self, store: &mut impl AsStoreMut) -> Value

Retrieves the current value Value that the global has.

Example

let g = Global::new(&mut store, Value::I32(1));

assert_eq!(g.get(&mut store), Value::I32(1));

pub fn set( &self, store: &mut impl AsStoreMut, val: Value, ) -> Result<(), RuntimeError>

Sets a custom Value to the runtime global.

Example

let g = Global::new_mut(&mut store, Value::I32(1));

assert_eq!(g.get(&mut store), Value::I32(1));

g.set(&mut store, Value::I32(2));

assert_eq!(g.get(&mut store), Value::I32(2));

Errors

Trying to mutate a immutable global will raise an error:

let g = Global::new(&mut store, Value::I32(1));

g.set(&mut store, Value::I32(2)).unwrap();

Trying to set a value of a incompatible type will raise an error:

let g = Global::new(&mut store, Value::I32(1));

// This results in an error: `RuntimeError`.
g.set(&mut store, Value::I64(2)).unwrap();

pub(crate) fn from_vm_extern( store: &mut impl AsStoreMut, vm_extern: VMExternGlobal, ) -> Self

pub fn is_from_store(&self, store: &impl AsStoreRef) -> bool

Checks whether this global can be used with the given context.

pub(crate) fn to_vm_extern(&self) -> VMExtern

Create a VMExtern from self.

Trait Implementations

impl Clone for BackendGlobal

fn clone(&self) -> BackendGlobal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackendGlobal

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

Formats the value using the given formatter.

impl From<BackendGlobal> for Global

fn from(value: BackendGlobal) -> Self

Converts to this type from the input type.

impl From<Global> for BackendGlobal

fn from(value: Global) -> Self

Converts to this type from the input type.

impl PartialEq for BackendGlobal

fn eq(&self, other: &BackendGlobal) -> 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 Eq for BackendGlobal

impl StructuralPartialEq for BackendGlobal