Enum wasmtime::Val

pub enum Val {
    I32(i32),
    I64(i64),
    F32(u32),
    F64(u64),
    V128(u128),
    FuncRef(Option<Func>),
    ExternRef(Option<ExternRef>),
}

Possible runtime values that a WebAssembly module can either consume or produce.

Variants

I32(i32)

A 32-bit integer

Tuple Fields of I32

0: i32

I64(i64)

A 64-bit integer

Tuple Fields of I64

0: i64

F32(u32)

A 32-bit float.

Note that the raw bits of the float are stored here, and you can use f32::from_bits to create an f32 value.

Tuple Fields of F32

0: u32

F64(u64)

A 64-bit float.

Note that the raw bits of the float are stored here, and you can use f64::from_bits to create an f64 value.

Tuple Fields of F64

0: u64

V128(u128)

A 128-bit number

Tuple Fields of V128

0: u128

FuncRef(Option<Func>)

A first-class reference to a WebAssembly function.

FuncRef(None) is the null function reference, created by ref.null func in Wasm.

Tuple Fields of FuncRef

0: Option<Func>

ExternRef(Option<ExternRef>)

An externref value which can hold opaque data to the Wasm instance itself.

ExternRef(None) is the null external reference, created by ref.null extern in Wasm.

Tuple Fields of ExternRef

0: Option<ExternRef>

Implementations

impl Val

pub fn null() -> Val

Returns a null externref value.

pub fn ty(&self) -> ValType

Returns the corresponding ValType for this Val.

pub unsafe fn to_raw(&self, store: impl AsContextMut) -> ValRaw

Convenience method to convert this Val into a ValRaw.

Unsafety

This method is unsafe for the reasons that ExternRef::to_raw and Func::to_raw are unsafe.

pub unsafe fn from_raw(
    store: impl AsContextMut,
    raw: ValRaw,
    ty: ValType
) -> Val

Convenience method to convert a ValRaw into a Val.

Unsafety

This method is unsafe for the reasons that ExternRef::from_raw and Func::from_raw are unsafe. Additionaly there’s no guarantee otherwise that raw should have the type ty specified.

pub fn i32(&self) -> Option<i32>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_i32(&self) -> i32

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn i64(&self) -> Option<i64>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_i64(&self) -> i64

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn f32(&self) -> Option<f32>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_f32(&self) -> f32

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn f64(&self) -> Option<f64>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_f64(&self) -> f64

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn funcref(&self) -> Option<Option<&Func>>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_funcref(&self) -> Option<&Func>

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn v128(&self) -> Option<u128>

Attempt to access the underlying value of this Val, returning None if it is not the correct type.

pub fn unwrap_v128(&self) -> u128

Returns the underlying value of this Val, panicking if it’s the wrong type.

Panics

Panics if self is not of the right type.

pub fn externref(&self) -> Option<Option<ExternRef>>

Attempt to access the underlying externref value of this Val.

If this is not an externref, then None is returned.

If this is a null externref, then Some(None) is returned.

If this is a non-null externref, then Some(Some(..)) is returned.

pub fn unwrap_externref(&self) -> Option<ExternRef>

Returns the underlying externref value of this Val, panicking if it’s the wrong type.

If this is a null externref, then None is returned.

If this is a non-null externref, then Some(..) is returned.

Panics

Panics if self is not a (nullable) externref.

Trait Implementations

impl Clone for Val

fn clone(&self) -> Val

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.

impl From<ExternRef> for Val

fn from(val: ExternRef) -> Val

Performs the conversion.

impl From<Func> for Val

fn from(val: Func) -> Val

Performs the conversion.

impl From<Option<ExternRef>> for Val

fn from(val: Option<ExternRef>) -> Val

Performs the conversion.

impl From<Option<Func>> for Val

fn from(val: Option<Func>) -> Val

Performs the conversion.

impl From<f32> for Val

fn from(val: f32) -> Val

Performs the conversion.

impl From<f64> for Val

fn from(val: f64) -> Val

Performs the conversion.

impl From<i32> for Val

fn from(val: i32) -> Val

Performs the conversion.

impl From<i64> for Val

fn from(val: i64) -> Val

Performs the conversion.

impl From<u128> for Val

fn from(val: u128) -> Val

Performs the conversion.