Struct Function

pub struct Function {
    pub name: String,
    pub kind: FunctionKind,
    pub params: Params,
    pub results: Results,
    pub docs: Docs,
    pub stability: Stability,
}

Fields

name: String

kind: FunctionKind

params: Params

results: Results

docs: Docs

stability: Stability

Stability attribute for this function.

Implementations

impl Function

pub fn item_name(&self) -> &str

pub fn parameter_and_result_types(&self) -> impl Iterator<Item = Type> + '_

Returns an iterator over the types used in parameters and results.

Note that this iterator is not transitive, it only iterates over the direct references to types that this function has.

pub fn standard32_core_export_name<'a>( &'a self, interface: Option<&str>, ) -> Cow<'a, str>

Gets the core export name for this function.

pub fn legacy_core_export_name<'a>( &'a self, interface: Option<&str>, ) -> Cow<'a, str>

pub fn core_export_name<'a>( &'a self, interface: Option<&str>, mangling: Mangling, ) -> Cow<'a, str>

Gets the core export name for this function.

pub fn find_futures_and_streams(&self, resolve: &Resolve) -> Vec<TypeId>

Collect any future and stream types appearing in the signature of this function by doing a depth-first search over the parameter types and then the result types.

For example, given the WIT function foo: func(x: future<future<u32>>, y: u32) -> stream<u8>, we would return [future<u32>, future<future<u32>>, stream<u8>].

This may be used by binding generators to refer to specific future and stream types when importing canonical built-ins such as stream.new, future.read, etc. Using the example above, the import [future-new-0]foo would indicate a call to future.new for the type future<u32>. Likewise, [future-new-1]foo would indicate a call to future.new for future<future<u32>>, and [stream-new-2]foo would indicate a call to stream.new for stream<u8>.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Function

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Function

impl StructuralPartialEq for Function