Enum Ref

pub enum Ref {
    Func(Option<Func>),
    Extern(Option<Rooted<ExternRef>>),
    Any(Option<Rooted<AnyRef>>),
}

Available on crate feature runtime only.

A reference.

References come in three broad flavors:

1. Function references. These are references to a function that can be invoked.

2. External references. These are references to data that is external and opaque to the Wasm guest, provided by the host.

3. Internal references. These are references to allocations inside the Wasm’s heap, such as structs and arrays. These are part of the GC proposal, and not yet implemented in Wasmtime.

At the Wasm level, there are nullable and non-nullable variants of each type of reference. Both variants are represented with Ref at the Wasmtime API level. For example, values of both (ref extern) and (ref null extern) types will be represented as Ref::Extern(Option<ExternRef>) in the Wasmtime API. Nullable references are represented as Option<Ref> where null references are represented as None. Wasm can construct null references via the ref.null <heap-type> instruction.

References are non-forgable: Wasm cannot create invalid references, for example, by claiming that the integer 0xbad1bad2 is actually a reference.

Variants

Func(Option<Func>)

A first-class reference to a WebAssembly function.

The host, or the Wasm guest, can invoke this function.

The host can create function references via Func::new or Func::wrap.

The Wasm guest can create non-null function references via the ref.func instruction, or null references via the ref.null func instruction.

Extern(Option<Rooted<ExternRef>>)

A reference to an value outside of the Wasm heap.

These references are opaque to the Wasm itself. Wasm can’t create non-null external references, nor do anything with them accept pass them around as function arguments and returns and place them into globals and tables.

Wasm can create null external references via the ref.null extern instruction.

Any(Option<Rooted<AnyRef>>)

An internal reference.

The AnyRef type represents WebAssembly anyref values. These can be references to structs and arrays or inline/unboxed 31-bit integers.

Unlike externref, Wasm guests can directly allocate anyrefs, and does not need to rely on the host to do that.

Implementations

impl Ref

pub fn null(heap_type: &HeapType) -> Self

Create a null reference to the given heap type.

pub fn is_null(&self) -> bool

Is this a null reference?

pub fn is_non_null(&self) -> bool

Is this a non-null reference?

pub fn is_extern(&self) -> bool

Is this an extern reference?

pub fn as_extern(&self) -> Option<Option<&Rooted<ExternRef>>>

Get the underlying extern reference, if any.

Returns None if this Ref is not an extern reference, eg it is a func reference.

Returns Some(None) if this Ref is a null extern reference.

Returns Some(Some(_)) if this Ref is a non-null extern reference.

pub fn unwrap_extern(&self) -> Option<&Rooted<ExternRef>>

Get the underlying extern reference, panicking if this is a different kind of reference.

Returns None if this Ref is a null extern reference.

Returns Some(_) if this Ref is a non-null extern reference.

pub fn is_any(&self) -> bool

Is this an any reference?

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

Get the underlying any reference, if any.

Returns None if this Ref is not an any reference, eg it is a func reference.

Returns Some(None) if this Ref is a null any reference.

Returns Some(Some(_)) if this Ref is a non-null any reference.

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

Get the underlying any reference, panicking if this is a different kind of reference.

Returns None if this Ref is a null any reference.

Returns Some(_) if this Ref is a non-null any reference.

pub fn is_func(&self) -> bool

Is this a func reference?

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

Get the underlying func reference, if any.

Returns None if this Ref is not an func reference, eg it is an extern reference.

Returns Some(None) if this Ref is a null func reference.

Returns Some(Some(_)) if this Ref is a non-null func reference.

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

Get the underlying func reference, panicking if this is a different kind of reference.

Returns None if this Ref is a null func reference.

Returns Some(_) if this Ref is a non-null func reference.

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

Get the type of this reference.

Errors

Return an error if this reference has been unrooted.

Panics

Panics if this reference is associated with a different store.

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

Does this reference value match the given type?

Returns an error if the underlying Rooted has been unrooted.

Panics

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

Trait Implementations

impl Clone for Ref

fn clone(&self) -> Ref

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ref

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

Formats the value using the given formatter.

impl From<Func> for Ref

fn from(f: Func) -> Ref

Converts to this type from the input type.

impl From<Option<Func>> for Ref

fn from(f: Option<Func>) -> Ref

Converts to this type from the input type.

impl From<Option<Rooted<AnyRef>>> for Ref

fn from(e: Option<Rooted<AnyRef>>) -> Ref

Converts to this type from the input type.

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

fn from(e: Option<Rooted<ArrayRef>>) -> Ref

Converts to this type from the input type.

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

fn from(e: Option<Rooted<ExternRef>>) -> Ref

Converts to this type from the input type.

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

fn from(e: Option<Rooted<StructRef>>) -> Ref

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 Ref

fn from(e: Rooted<AnyRef>) -> Ref

Converts to this type from the input type.

impl From<Rooted<ArrayRef>> for Ref

fn from(e: Rooted<ArrayRef>) -> Ref

Converts to this type from the input type.

impl From<Rooted<ExternRef>> for Ref

fn from(e: Rooted<ExternRef>) -> Ref

Converts to this type from the input type.

impl From<Rooted<StructRef>> for Ref

fn from(e: Rooted<StructRef>) -> Ref

Converts to this type from the input type.