Struct wasmtime::RefType

source ·
pub struct RefType { /* private fields */ }
Expand description

Opaque references to data in the Wasm heap or to host data.

§Subtyping and Equality

RefType does not implement Eq, because reference types have a subtyping relationship, and so 99.99% of the time you actually want to check whether one type matches (i.e. is a subtype of) another type. You can use the RefType::matches and Ref::matches_ty methods to perform these types of checks. If, however, you are in that 0.01% scenario where you need to check precise equality between types, you can use the RefType::eq method.

Implementations§

source§

impl RefType

source

pub const EXTERNREF: Self = _

The externref type, aka (ref null extern).

source

pub const NULLEXTERNREF: Self = _

The nullexternref type, aka (ref null noextern).

source

pub const FUNCREF: Self = _

The funcref type, aka (ref null func).

source

pub const NULLFUNCREF: Self = _

The nullfuncref type, aka (ref null nofunc).

source

pub const ANYREF: Self = _

The anyref type, aka (ref null any).

source

pub const EQREF: Self = _

The eqref type, aka (ref null eq).

source

pub const I31REF: Self = _

The i31ref type, aka (ref null i31).

source

pub const ARRAYREF: Self = _

The arrayref type, aka (ref null array).

source

pub const STRUCTREF: Self = _

The structref type, aka (ref null struct).

source

pub const NULLREF: Self = _

The nullref type, aka (ref null none).

source

pub fn new(is_nullable: bool, heap_type: HeapType) -> RefType

Construct a new reference type.

source

pub fn is_nullable(&self) -> bool

Can this type of reference be null?

source

pub fn heap_type(&self) -> &HeapType

The heap type that this is a reference to.

source

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

Does this reference type match the other?

That is, is this reference type a subtype of the other?

§Panics

Panics if either type is associated with a different engine from the other.

source

pub fn eq(a: &RefType, b: &RefType) -> bool

Is reference type a precisely equal to reference type b?

Returns false even if a is a subtype of b or vice versa, if they are not exactly the same reference type.

§Panics

Panics if either type is associated with a different engine.

Trait Implementations§

source§

impl Clone for RefType

source§

fn clone(&self) -> RefType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RefType

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for RefType

source§

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

Formats the value using the given formatter. Read more
source§

impl From<RefType> for ValType

source§

fn from(r: RefType) -> Self

Converts to this type from the input type.
source§

impl Hash for RefType

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.