Struct CanonicalFunctionSection

pub struct CanonicalFunctionSection { /* private fields */ }

Available on crate feature component-model only.

An encoder for the canonical function section of WebAssembly components.

Example

use wasm_encoder::{Component, CanonicalFunctionSection, CanonicalOption};

let mut functions = CanonicalFunctionSection::new();
functions.lift(0, 0, [CanonicalOption::UTF8]);

let mut component = Component::new();
component.section(&functions);

let bytes = component.finish();

Implementations

impl CanonicalFunctionSection

pub fn new() -> Self

Construct a new component function section encoder.

pub fn len(&self) -> u32

The number of functions in the section.

pub fn is_empty(&self) -> bool

Determines if the section is empty.

pub fn lift<O>( &mut self, core_func_index: u32, type_index: u32, options: O, ) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Define a function that will lift a core WebAssembly function to the canonical ABI.

pub fn lower<O>(&mut self, func_index: u32, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Define a function that will lower a canonical ABI function to a core WebAssembly function.

pub fn resource_new(&mut self, ty_index: u32) -> &mut Self

Defines a function which will create an owned handle to the resource specified by ty_index.

pub fn resource_drop(&mut self, ty_index: u32) -> &mut Self

Defines a function which will drop the specified type of handle.

pub fn resource_rep(&mut self, ty_index: u32) -> &mut Self

Defines a function which will return the representation of the specified resource type.

pub fn thread_spawn(&mut self, ty_index: u32) -> &mut Self

Defines a function which will spawns a new thread by invoking a shared function of type ty_index.

pub fn thread_hw_concurrency(&mut self) -> &mut Self

Defines a function which will return the number of threads that can be expected to execute concurrently.

pub fn task_backpressure(&mut self) -> &mut Self

Defines a function which tells the host to enable or disable backpressure for the caller’s instance. When backpressure is enabled, the host must not start any new calls to that instance until backpressure is disabled.

pub fn task_return(&mut self, ty: u32) -> &mut Self

Defines a function which returns a result to the caller of a lifted export function. This allows the callee to continue executing after returning a result.

pub fn task_wait(&mut self, async_: bool, memory: u32) -> &mut Self

Defines a function which waits for at least one outstanding async task/stream/future to make progress, returning the first such event.

If async_ is true, the caller instance may be reentered.

pub fn task_poll(&mut self, async_: bool, memory: u32) -> &mut Self

Defines a function which checks whether any outstanding async task/stream/future has made progress. Unlike task.wait, this does not block and may return nothing if no such event has occurred.

If async_ is true, the caller instance may be reentered.

pub fn task_yield(&mut self, async_: bool) -> &mut Self

Defines a function which yields control to the host so that other tasks are able to make progress, if any.

If async_ is true, the caller instance may be reentered.

pub fn subtask_drop(&mut self) -> &mut Self

Defines a function to drop a specified task which has completed.

pub fn stream_new(&mut self, ty: u32) -> &mut Self

Defines a function to create a new stream handle of the specified type.

pub fn stream_read<O>(&mut self, ty: u32, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to read from a stream of the specified type.

pub fn stream_write<O>(&mut self, ty: u32, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to write to a stream of the specified type.

pub fn stream_cancel_read(&mut self, ty: u32, async_: bool) -> &mut Self

Defines a function to cancel an in-progress read from a stream of the specified type.

pub fn stream_cancel_write(&mut self, ty: u32, async_: bool) -> &mut Self

Defines a function to cancel an in-progress write to a stream of the specified type.

pub fn stream_close_readable(&mut self, ty: u32) -> &mut Self

Defines a function to close the readable end of a stream of the specified type.

pub fn stream_close_writable(&mut self, ty: u32) -> &mut Self

Defines a function to close the writable end of a stream of the specified type.

pub fn future_new(&mut self, ty: u32) -> &mut Self

Defines a function to create a new future handle of the specified type.

pub fn future_read<O>(&mut self, ty: u32, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to read from a future of the specified type.

pub fn future_write<O>(&mut self, ty: u32, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to write to a future of the specified type.

pub fn future_cancel_read(&mut self, ty: u32, async_: bool) -> &mut Self

Defines a function to cancel an in-progress read from a future of the specified type.

pub fn future_cancel_write(&mut self, ty: u32, async_: bool) -> &mut Self

Defines a function to cancel an in-progress write to a future of the specified type.

pub fn future_close_readable(&mut self, ty: u32) -> &mut Self

Defines a function to close the readable end of a future of the specified type.

pub fn future_close_writable(&mut self, ty: u32) -> &mut Self

Defines a function to close the writable end of a future of the specified type.

pub fn error_context_new<O>(&mut self, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to create a new error-context with a specified debug message.

pub fn error_context_debug_message<O>(&mut self, options: O) -> &mut Self

where O: IntoIterator<Item = CanonicalOption>, O::IntoIter: ExactSizeIterator,

Defines a function to get the debug message for a specified error-context.

Note that the debug message might not necessarily match what was passed to error-context.new.

pub fn error_context_drop(&mut self) -> &mut Self

Defines a function to drop a specified error-context.

Trait Implementations

impl Clone for CanonicalFunctionSection

fn clone(&self) -> CanonicalFunctionSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentSection for CanonicalFunctionSection

fn id(&self) -> u8

Gets the section identifier for this section.

fn append_to_component(&self, dst: &mut Vec<u8>)

Appends this section to the specified destination list of bytes.

impl Debug for CanonicalFunctionSection

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

Formats the value using the given formatter.

impl Default for CanonicalFunctionSection

fn default() -> CanonicalFunctionSection

Returns the “default value” for a type.

impl Encode for CanonicalFunctionSection

fn encode(&self, sink: &mut Vec<u8>)

Encode the type into the given byte sink.