Skip to main content

NoFunc

Struct NoFunc 

Source
pub struct NoFunc { /* private fields */ }
Expand description

A reference to the abstract nofunc heap value.

The are no instances of (ref nofunc): it is an uninhabited type.

There is precisely one instance of (ref null nofunc), aka nullfuncref: the null reference.

This NoFunc Rust type’s sole purpose is for use with Func::wrap- and Func::typed-style APIs for statically typing a function as taking or returning a (ref null nofunc) (aka Option<NoFunc>) which is always None.

§Example

let mut config = Config::new();
config.wasm_function_references(true);
let engine = Engine::new(&config)?;

let module = Module::new(
    &engine,
    r#"
        (module
            (func (export "f") (param (ref null nofunc))
                ;; If the reference is null, return.
                local.get 0
                ref.is_null nofunc
                br_if 0

                ;; If the reference was not null (which is impossible)
                ;; then raise a trap.
                unreachable
            )
        )
    "#,
)?;

let mut store = Store::new(&engine, ());
let instance = Instance::new(&mut store, &module, &[])?;
let f = instance.get_func(&mut store, "f").unwrap();

// We can cast a `(ref null nofunc)`-taking function into a typed function that
// takes an `Option<NoFunc>` via the `Func::typed` method.
let f = f.typed::<Option<NoFunc>, ()>(&store)?;

// We can call the typed function, passing the null `nofunc` reference.
let result = f.call(&mut store, NoFunc::null());

// The function should not have trapped, because the reference we gave it was
// null (as it had to be, since `NoFunc` is uninhabited).
assert!(result.is_ok());

Implementations§

Source§

impl NoFunc

Source

pub fn null() -> Option<NoFunc>

Get the null (ref null nofunc) (aka nullfuncref) reference.

Source

pub fn null_ref() -> Ref

Get the null (ref null nofunc) (aka nullfuncref) reference as a Ref.

Source

pub fn null_val() -> Val

Get the null (ref null nofunc) (aka nullfuncref) reference as a Val.

Trait Implementations§

Source§

impl Clone for NoFunc

Source§

fn clone(&self) -> NoFunc

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NoFunc

Source§

impl Debug for NoFunc

Source§

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

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

impl Eq for NoFunc

Source§

impl PartialEq for NoFunc

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NoFunc

Source§

impl WasmTy for NoFunc

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.
Source§

impl<T> WasmParams for T
where T: WasmTy,

Source§

type Abi = <(T,) as WasmParams>::Abi

Source§

fn typecheck( engine: &Engine, params: impl ExactSizeIterator<Item = ValType>, position: TypeCheckPosition, ) -> Result<(), Error>

Source§

fn externrefs_count(&self) -> usize

Source§

fn into_abi( self, store: &mut StoreOpaque, func_ty: &FuncType, ) -> Result<<T as WasmParams>::Abi, Error>

Source§

unsafe fn invoke<R>( func: NonNull<VMNativeCallFunction>, vmctx1: *mut VMOpaqueContext, vmctx2: *mut VMContext, abi: <T as WasmParams>::Abi, ) -> <R as WasmResults>::ResultAbi
where R: WasmResults,

Source§

impl<T> WasmResults for T
where T: WasmTy, (<T as WasmTy>::Abi,): HostAbi,

Source§

type ResultAbi = <(T,) as WasmResults>::ResultAbi

Source§

unsafe fn from_abi( store: &mut StoreOpaque, abi: <T as WasmResults>::ResultAbi, ) -> T

Source§

impl<T> WasmRet for T
where T: WasmTy,

Source§

type Abi = <T as WasmTy>::Abi

Source§

type Retptr = ()

Source§

type Fallible = Result<T, Error>

Source§

fn compatible_with_store(&self, store: &StoreOpaque) -> bool

Source§

unsafe fn into_abi_for_ret( self, store: &mut StoreOpaque, _retptr: (), ) -> Result<<T as WasmRet>::Abi, Error>

Source§

fn func_type(engine: &Engine, params: impl Iterator<Item = ValType>) -> FuncType

Source§

unsafe fn wrap_trampoline( ptr: *mut ValRaw, f: impl FnOnce(<T as WasmRet>::Retptr) -> <T as WasmRet>::Abi, )

Source§

fn into_fallible(self) -> Result<T, Error>

Source§

fn fallible_from_error(error: Error) -> Result<T, Error>