Struct wasmtime::Global

source ·
pub struct Global(/* private fields */);
Expand description

A WebAssembly global value which can be read and written to.

A global in WebAssembly is sort of like a global variable within an Instance. The global.get and global.set instructions will modify and read global values in a wasm module. Globals can either be imported or exported from wasm modules.

A Global “belongs” to the store that it was originally created within (either via Global::new or via instantiating a Module). Operations on a Global only work with the store it belongs to, and if another store is passed in by accident then methods will panic.

Implementations§

source§

impl Global

source

pub fn new(store: impl AsContextMut, ty: GlobalType, val: Val) -> Result<Global>

Creates a new WebAssembly global value with the provide type ty and initial value val.

The store argument will be the owner of the Global returned. Using the returned Global other items in the store may access this global. For example this could be provided as an argument to Instance::new or Linker::define.

§Errors

Returns an error if the ty provided does not match the type of the value val, or if val comes from a different store than store.

§Examples
let engine = Engine::default();
let mut store = Store::new(&engine, ());

let ty = GlobalType::new(ValType::I32, Mutability::Const);
let i32_const = Global::new(&mut store, ty, 1i32.into())?;
let ty = GlobalType::new(ValType::F64, Mutability::Var);
let f64_mut = Global::new(&mut store, ty, 2.0f64.into())?;

let module = Module::new(
    &engine,
    "(module
        (global (import \"\" \"i32-const\") i32)
        (global (import \"\" \"f64-mut\") (mut f64))
    )"
)?;

let mut linker = Linker::new(&engine);
linker.define(&store, "", "i32-const", i32_const)?;
linker.define(&store, "", "f64-mut", f64_mut)?;

let instance = linker.instantiate(&mut store, &module)?;
// ...
source

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

Returns the underlying type of this global.

§Panics

Panics if store does not own this global.

source

pub fn get(&self, store: impl AsContextMut) -> Val

Returns the current Val of this global.

§Panics

Panics if store does not own this global.

source

pub fn set(&self, store: impl AsContextMut, val: Val) -> Result<()>

Attempts to set the current value of this global to Val.

§Errors

Returns an error if this global has a different type than Val, if it’s not a mutable global, or if val comes from a different store than the one provided.

§Panics

Panics if store does not own this global.

Trait Implementations§

source§

impl Clone for Global

source§

fn clone(&self) -> Global

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Global

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Global> for Extern

source§

fn from(r: Global) -> Self

Converts to this type from the input type.
source§

impl Copy for Global

Auto Trait Implementations§

§

impl Freeze for Global

§

impl RefUnwindSafe for Global

§

impl Send for Global

§

impl Sync for Global

§

impl Unpin for Global

§

impl UnwindSafe for Global

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.