Struct cranelift_wasm::wasmparser::RefType

pub struct RefType(/* private fields */);

A reference type.

The reference types proposal first introduced externref and funcref.

The function references proposal introduced typed function references.

The GC proposal introduces heap types: any, eq, i31, struct, array, nofunc, noextern, none.

Implementations

impl RefType

pub const FUNCREF: RefType = _

A nullable untyped function reference aka (ref null func) aka funcref aka anyfunc.

pub const EXTERNREF: RefType = _

A nullable reference to an extern object aka (ref null extern) aka externref.

pub const FUNC: RefType = _

A non-nullable untyped function reference aka (ref func).

pub const EXTERN: RefType = _

A non-nullable reference to an extern object aka (ref extern).

pub const ANY: RefType = _

A non-nullable reference to any object aka (ref any).

pub const NONE: RefType = _

A non-nullable reference to no object aka (ref none).

pub const NOEXTERN: RefType = _

A non-nullable reference to a noextern object aka (ref noextern).

pub const NOFUNC: RefType = _

A non-nullable reference to a nofunc object aka (ref nofunc).

pub const EQ: RefType = _

A non-nullable reference to an eq object aka (ref eq).

pub const STRUCT: RefType = _

A non-nullable reference to a struct aka (ref struct).

pub const ARRAY: RefType = _

A non-nullable reference to an array aka (ref array).

pub const I31: RefType = _

A non-nullable reference to an i31 object aka (ref i31).

pub const fn indexed_func(nullable: bool, index: u32) -> Option<RefType>

Create a reference to a typed function with the type at the given index.

Returns None when the type index is beyond this crate’s implementation limits and therefore is not representable.

pub const fn indexed_array(nullable: bool, index: u32) -> Option<RefType>

Create a reference to an array with the type at the given index.

Returns None when the type index is beyond this crate’s implementation limits and therefore is not representable.

pub const fn indexed_struct(nullable: bool, index: u32) -> Option<RefType>

Create a reference to a struct with the type at the given index.

Returns None when the type index is beyond this crate’s implementation limits and therefore is not representable.

pub const fn new(nullable: bool, heap_type: HeapType) -> Option<RefType>

Create a new RefType.

Returns None when the heap type’s type index (if any) is beyond this crate’s implementation limits and therfore is not representable.

pub const fn is_typed_func_ref(&self) -> bool

Is this a reference to a typed function?

pub const fn is_indexed_type_ref(&self) -> bool

Is this a reference to an indexed type?

pub const fn type_index(&self) -> Option<u32>

If this is a reference to a typed function, get its type index.

pub const fn is_func_ref(&self) -> bool

Is this an untyped function reference aka (ref null func) aka funcref aka anyfunc?

pub const fn is_extern_ref(&self) -> bool

Is this a (ref null extern) aka externref?

pub const fn is_nullable(&self) -> bool

Is this ref type nullable?

pub const fn as_non_null(&self) -> RefType

Get the non-nullable version of this ref type.

pub const fn nullable(&self) -> RefType

Get the non-nullable version of this ref type.

pub fn heap_type(&self) -> HeapType

Get the heap type that this is a reference to.

Trait Implementations

impl Clone for RefType

fn clone(&self) -> RefType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefType

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

Formats the value using the given formatter.

impl Display for RefType

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

Formats the value using the given formatter.

impl From<RefType> for ValType

fn from(ty: RefType) -> ValType

Converts to this type from the input type.

impl<'a> FromReader<'a> for RefType

fn from_reader( reader: &mut BinaryReader<'a> ) -> Result<RefType, BinaryReaderError>

Attempts to read Self from the provided binary reader, returning an error if it is unable to do so.

impl Hash for RefType

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<RefType> for RefType

fn eq(&self, other: &RefType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RefType

impl Eq for RefType

impl StructuralEq for RefType

impl StructuralPartialEq for RefType