Enum wasmtime::Val

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

Available on crate feature runtime only.

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

Note that we inline the enum Ref { ... } variants into enum Val { ... } here as a size optimization.

Variants

I32(i32)

A 32-bit integer.

I64(i64)

A 64-bit integer.

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.

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.

V128(V128)

A 128-bit number.

FuncRef(Option<Func>)

A function reference.

ExternRef(Option<ExternRef>)

An external reference.

Implementations

impl Val

pub const fn null_func_ref() -> Val

Returns the null function reference value.

The return value has type (ref null nofunc) aka nullfuncref and is a subtype of all function references.

pub const fn null_extern_ref() -> Val

Returns the null function reference value.

The return value has type (ref null extern) aka nullexternref and is a subtype of all external references.

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

Returns the corresponding ValType for this Val.

pub fn matches_ty(&self, store: impl AsContext, ty: &ValType) -> bool

Does this value match the given type?

Panics

Panics if this value is not associated with the given store.

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 func_ref(&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_func_ref(&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 extern_ref(&self) -> Option<Option<&ExternRef>>

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

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

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<V128>

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

pub fn unwrap_v128(&self) -> V128

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 ref_(self) -> Option<Ref>

Get this value’s underlying reference, if any.

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.

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

Attempt to access the underlying funcref value of this Val.

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

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

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

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

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

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

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

Panics

Panics if self is not a (nullable) funcref.

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

Converts to this type from the input type.

impl From<Func> for Val

fn from(val: Func) -> Val

Converts to this type from the input type.

impl From<Option<ExternRef>> for Val

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

Converts to this type from the input type.

impl From<Option<Func>> for Val

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

Converts to this type from the input type.

impl From<Ref> for Val

fn from(val: Ref) -> Val

Converts to this type from the input type.

impl From<V128> for Val

fn from(val: V128) -> Val

Converts to this type from the input type.

impl From<f32> for Val

fn from(val: f32) -> Val

Converts to this type from the input type.

impl From<f64> for Val

fn from(val: f64) -> Val

Converts to this type from the input type.

impl From<i32> for Val

fn from(val: i32) -> Val

Converts to this type from the input type.

impl From<i64> for Val

fn from(val: i64) -> Val

Converts to this type from the input type.

impl From<u128> for Val

fn from(val: u128) -> Val

Converts to this type from the input type.