wasm-wave 0.249.0

WebAssembly Value Encoding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use alloc::{borrow::Cow, boxed::Box};

use crate::wasm::WasmType;

// TODO: Given recent versions of rustc we may want to take a look at changing the returns of boxed
// iterators to -> impl Iterator

/// The WasmFunc trait may be implemented to represent Wasm func type
/// signatures to be (de)serialized with WAVE.
pub trait WasmFunc {
    /// A type representing types of these params and results.
    type Type: WasmType;

    /// Returns an iterator of the func's parameter types.
    fn params(&self) -> Box<dyn Iterator<Item = Self::Type> + '_>;

    /// Returns an iterator of the func's parameter names. Must be the same
    /// length as the iterator returned by `params` or empty if this WasmFunc
    /// impl does not support param names.
    fn param_names(&self) -> Box<dyn Iterator<Item = Cow<'_, str>> + '_> {
        Box::new(core::iter::empty())
    }

    /// Returns an iterator of the func's result types.
    fn results(&self) -> Box<dyn Iterator<Item = Self::Type> + '_>;

    /// Returns an iterator of the func's result names. Must be the same
    /// length as the iterator returned by `results` or empty if there are no
    /// named results or if this WasmFunc impl does not support result names.
    fn result_names(&self) -> Box<dyn Iterator<Item = Cow<'_, str>> + '_> {
        Box::new(core::iter::empty())
    }
}