wasmtime_environ

Struct WasmFuncType

source
pub struct WasmFuncType { /* private fields */ }
Expand description

WebAssembly function type – equivalent of wasmparser’s FuncType.

Implementations§

source§

impl WasmFuncType

source

pub fn new(params: Box<[WasmValType]>, returns: Box<[WasmValType]>) -> Self

Creates a new function type from the provided params and returns.

source

pub fn params(&self) -> &[WasmValType]

Function params types.

source

pub fn non_i31_gc_ref_params_count(&self) -> usize

How many externrefs are in this function’s params?

source

pub fn returns(&self) -> &[WasmValType]

Returns params types.

source

pub fn non_i31_gc_ref_returns_count(&self) -> usize

How many externrefs are in this function’s returns?

source

pub fn is_trampoline_type(&self) -> bool

Is this function type compatible with trampoline usage in Wasmtime?

source

pub fn trampoline_type(&self) -> Cow<'_, Self>

Get the version of this function type that is suitable for usage as a trampoline in Wasmtime.

If this function is suitable for trampoline usage as-is, then a borrowed Cow is returned. If it must be tweaked for trampoline usage, then an owned Cow is returned.

§What is a trampoline type?

All reference types in parameters and results are mapped to their nullable top type, e.g. (ref $my_struct_type) becomes (ref null any).

This allows us to share trampolines between functions whose signatures both map to the same trampoline type. It also allows the host to satisfy a Wasm module’s function import of type S with a function of type T where T <: S, even when the Wasm module never defines the type T (and might never even be able to!)

The flip side is that this adds a constraint to our trampolines: they can only pass references around (e.g. move a reference from one calling convention’s location to another’s) and may not actually inspect the references themselves (unless the trampolines start doing explicit, fallible downcasts, but if we ever need that, then we might want to redesign this stuff).

Trait Implementations§

source§

impl Clone for WasmFuncType

source§

fn clone(&self) -> WasmFuncType

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 WasmFuncType

source§

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

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

impl<'de> Deserialize<'de> for WasmFuncType

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for WasmFuncType

source§

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

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

impl Hash for WasmFuncType

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
source§

impl PartialEq for WasmFuncType

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for WasmFuncType

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl TypeTrace for WasmFuncType

source§

fn trace<F, E>(&self, func: &mut F) -> Result<(), E>

Visit each edge. Read more
source§

fn trace_mut<F, E>(&mut self, func: &mut F) -> Result<(), E>
where F: FnMut(&mut EngineOrModuleTypeIndex) -> Result<(), E>,

Visit each edge, mutably. Read more
source§

fn trace_engine_indices<F, E>(&self, func: &mut F) -> Result<(), E>
where F: FnMut(VMSharedTypeIndex) -> Result<(), E>,

Trace all VMSharedTypeIndex edges, ignoring other edges.
source§

fn canonicalize_for_runtime_usage<F>(&mut self, module_to_engine: &mut F)

Canonicalize self by rewriting all type references inside self from module-level interned type indices to engine-level interned type indices. Read more
source§

fn is_canonicalized_for_runtime_usage(&self) -> bool

Is this type canonicalized for runtime usage?
source§

fn canonicalize_for_hash_consing<F>( &mut self, rec_group_range: Range<ModuleInternedTypeIndex>, module_to_engine: &mut F, )

Canonicalize self by rewriting all type references inside self from module-level interned type indices to either engine-level interned type indices or recgroup-relative indices. Read more
source§

fn is_canonicalized_for_hash_consing(&self) -> bool

Is this type canonicalized for hash consing?
source§

impl Eq for WasmFuncType

source§

impl StructuralPartialEq for WasmFuncType

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
§

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

§

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

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

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

§

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

Compare self to key and return true if they are equal.
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> 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.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,