Enum Val 

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

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<Rooted<ExternRef>>)

An external reference.

AnyRef(Option<Rooted<AnyRef>>)

An internal reference.

ExnRef(Option<Rooted<ExnRef>>)

An exception reference.

ContRef(Option<ContRef>)

A continuation reference.

Note: This is currently a stub implementation as continuation objects are not yet fully integrated with the GC system. See #10248.

Implementations

impl Val

pub fn null_ref(heap_type: &HeapType) -> Val

Returns the null reference for the given heap type.

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 const fn null_any_ref() -> Val

Returns the null function reference value.

The return value has type (ref null any) aka nullref and is a subtype of all internal references.

pub fn default_for_ty(ty: &ValType) -> Option<Val>

Returns the default value for the given type, if any exists.

Returns None if there is no default value for the given type (for example, non-nullable reference types do not have a default value).

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

Returns the corresponding ValType for this Val.

Errors

Returns an error if this value is a GC reference that has since been unrooted.

Panics

Panics if this value is associated with a different store.

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

Does this value match the given type?

Returns an error is an underlying Rooted has been unrooted.

Panics

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

pub fn to_raw(&self, store: impl AsContextMut) -> Result<ValRaw, Error>

Convenience method to convert this Val into a ValRaw.

Returns an error if this value is a GC reference and the GC reference has been unrooted.

Safety

The returned ValRaw does not carry type information and is only safe to use within the context of this store itself. For more information see ExternRef::to_raw and Func::to_raw.

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. Additionally 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<&Rooted<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<&Rooted<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 any_ref(&self) -> Option<Option<&Rooted<AnyRef>>>

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

pub fn unwrap_any_ref(&self) -> Option<&Rooted<AnyRef>>

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<&Rooted<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<&Rooted<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 anyref(&self) -> Option<Option<&Rooted<AnyRef>>>

Attempt to access the underlying anyref value of this Val.

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

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

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

pub fn unwrap_anyref(&self) -> Option<&Rooted<AnyRef>>

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

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

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

Panics

Panics if self is not a (nullable) anyref.

pub fn exnref(&self) -> Option<Option<&Rooted<ExnRef>>>

Attempt to access the underlying exnref value of this Val.

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

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

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

pub fn unwrap_exnref(&self) -> Option<&Rooted<ExnRef>>

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

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

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

Panics

Panics if self is not a (nullable) exnref.

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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl From<Func> for Val

fn from(val: Func) -> 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<Option<Rooted<AnyRef>>> for Val

fn from(val: Option<Rooted<AnyRef>>) -> Val

Converts to this type from the input type.

impl From<Option<Rooted<ArrayRef>>> for Val

fn from(val: Option<Rooted<ArrayRef>>) -> Val

Converts to this type from the input type.

impl From<Option<Rooted<ExnRef>>> for Val

fn from(val: Option<Rooted<ExnRef>>) -> Val

Converts to this type from the input type.

impl From<Option<Rooted<ExternRef>>> for Val

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

Converts to this type from the input type.

impl From<Option<Rooted<StructRef>>> for Val

fn from(val: Option<Rooted<StructRef>>) -> 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<Rooted<AnyRef>> for Val

fn from(val: Rooted<AnyRef>) -> Val

Converts to this type from the input type.

impl From<Rooted<ArrayRef>> for Val

fn from(val: Rooted<ArrayRef>) -> Val

Converts to this type from the input type.

impl From<Rooted<ExnRef>> for Val

fn from(val: Rooted<ExnRef>) -> Val

Converts to this type from the input type.

impl From<Rooted<ExternRef>> for Val

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

Converts to this type from the input type.

impl From<Rooted<StructRef>> for Val

fn from(val: Rooted<StructRef>) -> 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.

impl WasmValue for Val

type Type = ValType

A type representing types of these values.

fn kind(&self) -> WasmTypeKind

The kind of type of this value.

fn make_s32(val: i32) -> Val

Returns a new WasmValue of the given type.

fn make_s64(val: i64) -> Val

Returns a new WasmValue of the given type.

fn make_f32(val: f32) -> Val

Returns a new WasmValue of the given type.

fn make_f64(val: f64) -> Val

Returns a new WasmValue of the given type.

fn make_tuple( ty: &<Val as WasmValue>::Type, vals: impl IntoIterator<Item = Val>, ) -> Result<Val, WasmValueError>

Returns a new WasmValue of the given type.

fn unwrap_s32(&self) -> i32

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_s64(&self) -> i64

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_f32(&self) -> f32

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_f64(&self) -> f64

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_tuple(&self) -> Box<dyn Iterator<Item = Cow<'_, Val>> + '_>

Returns an iterator of the field Vals of the tuple.

fn make_bool(val: bool) -> Self

Returns a new WasmValue of the given type.

fn make_s8(val: i8) -> Self

Returns a new WasmValue of the given type.

fn make_s16(val: i16) -> Self

Returns a new WasmValue of the given type.

fn make_u8(val: u8) -> Self

Returns a new WasmValue of the given type.

fn make_u16(val: u16) -> Self

Returns a new WasmValue of the given type.

fn make_u32(val: u32) -> Self

Returns a new WasmValue of the given type.

fn make_u64(val: u64) -> Self

Returns a new WasmValue of the given type.

fn make_char(val: char) -> Self

Returns a new WasmValue of the given type.

fn make_string(val: Cow<'_, str>) -> Self

Returns a new WasmValue of the given type.

fn make_list( ty: &Self::Type, vals: impl IntoIterator<Item = Self>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_record<'a>( ty: &Self::Type, fields: impl IntoIterator<Item = (&'a str, Self)>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_variant( ty: &Self::Type, case: &str, val: Option<Self>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_enum(ty: &Self::Type, case: &str) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_option( ty: &Self::Type, val: Option<Self>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_result( ty: &Self::Type, val: Result<Option<Self>, Option<Self>>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn make_flags<'a>( ty: &Self::Type, names: impl IntoIterator<Item = &'a str>, ) -> Result<Self, WasmValueError>

Returns a new WasmValue of the given type.

fn unwrap_bool(&self) -> bool

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_s8(&self) -> i8

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_s16(&self) -> i16

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_u8(&self) -> u8

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_u16(&self) -> u16

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_u32(&self) -> u32

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_u64(&self) -> u64

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_char(&self) -> char

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_string(&self) -> Cow<'_, str>

Returns the underlying value of the WasmValue, panicing if it’s the wrong type.

fn unwrap_list(&self) -> Box<dyn Iterator<Item = Cow<'_, Self>> + '_>

Returns an iterator of the element Vals of the list.

fn unwrap_record( &self, ) -> Box<dyn Iterator<Item = (Cow<'_, str>, Cow<'_, Self>)> + '_>

Returns an iterator of the field names and Vals of the record.

fn unwrap_variant(&self) -> (Cow<'_, str>, Option<Cow<'_, Self>>)

Returns the variant case name and optional payload WasmValue of the variant.

fn unwrap_enum(&self) -> Cow<'_, str>

Returns the case name of the enum.

fn unwrap_option(&self) -> Option<Cow<'_, Self>>

Returns the optional WasmValue.

fn unwrap_result(&self) -> Result<Option<Cow<'_, Self>>, Option<Cow<'_, Self>>>

Returns Ok() or Err() with the optional payload WasmValue.

fn unwrap_flags(&self) -> Box<dyn Iterator<Item = Cow<'_, str>> + '_>

Returns an iterator of the names of the flags WasmValue.

impl Copy for Val