Struct ComponentBuilder 

pub struct ComponentBuilder { /* private fields */ }

Convenience type to build a component incrementally and automatically keep track of index spaces.

This type is intended to be a wrapper around the Component encoding type which is useful for building it up incrementally over time. This type will automatically collect definitions into sections and reports the index of all items added by keeping track of indices internally.

Implementations

impl ComponentBuilder

pub fn core_module_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core modules.

pub fn core_func_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core funcs.

pub fn core_type_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core types.

pub fn core_memory_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core memories.

pub fn core_table_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core tables.

pub fn core_instance_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core instances.

pub fn core_tag_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core tags.

pub fn core_global_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of core globals.

pub fn func_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of component funcs.

pub fn instance_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of component instances.

pub fn value_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of component values.

pub fn component_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of components.

pub fn type_count(&self) -> u32

Available on crate feature component-model only.

Returns the current number of component types.

pub fn append_names(&mut self)

Available on crate feature component-model only.

Add all debug names registered to the component.

pub fn finish(self) -> Vec<u8>

Available on crate feature component-model only.

Completes this component and returns the binary encoding of the entire component.

pub fn core_module(&mut self, debug_name: Option<&str>, module: &Module) -> u32

Available on crate feature component-model only.

Encodes a core wasm Module into this component, returning its index.

pub fn core_module_raw( &mut self, debug_name: Option<&str>, module: &[u8], ) -> u32

Available on crate feature component-model only.

Encodes a core wasm module into this component, returning its index.

pub fn core_instantiate<'a, A>( &mut self, debug_name: Option<&str>, module_index: u32, args: A, ) -> u32

where A: IntoIterator<Item = (&'a str, ModuleArg)>, A::IntoIter: ExactSizeIterator,

Available on crate feature component-model only.

Instantiates a core wasm module at module_index with the args provided.

Returns the index of the core wasm instance created.

pub fn core_instantiate_exports<'a, E>( &mut self, debug_name: Option<&str>, exports: E, ) -> u32

where E: IntoIterator<Item = (&'a str, ExportKind, u32)>, E::IntoIter: ExactSizeIterator,

Available on crate feature component-model only.

Creates a new core wasm instance from the exports provided.

Returns the index of the core wasm instance created.

pub fn core_alias_export( &mut self, debug_name: Option<&str>, instance: u32, name: &str, kind: ExportKind, ) -> u32

Available on crate feature component-model only.

Creates a new aliased item where the core instance specified has its export name aliased out with the kind specified.

Returns the index of the item created.

pub fn alias(&mut self, debug_name: Option<&str>, alias: Alias<'_>) -> u32

Available on crate feature component-model only.

Adds a new alias to this component

pub fn alias_export( &mut self, instance: u32, name: &str, kind: ComponentExportKind, ) -> u32

Available on crate feature component-model only.

Creates an alias to a previous component instance’s exported item.

The instance provided is the instance to access and the name is the item to access.

Returns the index of the new item defined.

pub fn lower_func<O>( &mut self, debug_name: Option<&str>, func_index: u32, options: O, ) -> u32

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

Available on crate feature component-model only.

Lowers the func_index component function into a core wasm function using the options provided.

Returns the index of the core wasm function created.

pub fn lift_func<O>( &mut self, debug_name: Option<&str>, core_func_index: u32, type_index: u32, options: O, ) -> u32

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

Available on crate feature component-model only.

Lifts the core wasm core_func_index function with the component function type type_index and options.

Returns the index of the component function created.

pub fn import(&mut self, name: &str, ty: ComponentTypeRef) -> u32

Available on crate feature component-model only.

Imports a new item into this component with the name and ty specified.

pub fn export( &mut self, name: &str, kind: ComponentExportKind, idx: u32, ty: Option<ComponentTypeRef>, ) -> u32

Available on crate feature component-model only.

Exports a new item from this component with the name and kind specified.

The idx is the item to export and the ty is an optional type to ascribe to the export.

pub fn core_type( &mut self, debug_name: Option<&str>, ) -> (u32, ComponentCoreTypeEncoder<'_>)

Available on crate feature component-model only.

Creates a new encoder for the next core type in this component.

pub fn ty( &mut self, debug_name: Option<&str>, ) -> (u32, ComponentTypeEncoder<'_>)

Available on crate feature component-model only.

Creates a new encoder for the next type in this component.

pub fn type_instance( &mut self, debug_name: Option<&str>, ty: &InstanceType, ) -> u32

Available on crate feature component-model only.

Creates a new instance type within this component.

pub fn type_component( &mut self, debug_name: Option<&str>, ty: &ComponentType, ) -> u32

Available on crate feature component-model only.

Creates a new component type within this component.

pub fn type_defined( &mut self, debug_name: Option<&str>, ) -> (u32, ComponentDefinedTypeEncoder<'_>)

Available on crate feature component-model only.

Creates a new defined component type within this component.

pub fn type_function( &mut self, debug_name: Option<&str>, ) -> (u32, ComponentFuncTypeEncoder<'_>)

Available on crate feature component-model only.

Creates a new component function type within this component.

pub fn type_resource( &mut self, debug_name: Option<&str>, rep: ValType, dtor: Option<u32>, ) -> u32

Available on crate feature component-model only.

Declares a new resource type within this component.

pub fn component( &mut self, debug_name: Option<&str>, builder: ComponentBuilder, ) -> u32

Available on crate feature component-model only.

Defines a new subcomponent of this component.

pub fn component_raw(&mut self, debug_name: Option<&str>, data: &[u8]) -> u32

Available on crate feature component-model only.

Defines a new subcomponent of this component.

pub fn instantiate<A, S>( &mut self, debug_name: Option<&str>, component_index: u32, args: A, ) -> u32

where A: IntoIterator<Item = (S, ComponentExportKind, u32)>, A::IntoIter: ExactSizeIterator, S: AsRef<str>,

Available on crate feature component-model only.

Instantiates the component_index specified with the args specified.

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

Available on crate feature component-model only.

Declares a new resource.drop intrinsic.

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

Available on crate feature component-model only.

Declares a new resource.drop intrinsic.

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

Available on crate feature component-model only.

Declares a new resource.new intrinsic.

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

Available on crate feature component-model only.

Declares a new resource.rep intrinsic.

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

Available on crate feature component-model only.

Declares a new thread.spawn_ref intrinsic.

pub fn thread_available_parallelism(&mut self) -> u32

Available on crate feature component-model only.

Declares a new thread.available_parallelism intrinsic.

pub fn backpressure_set(&mut self) -> u32

Available on crate feature component-model only.

Declares a new backpressure.set intrinsic.

pub fn backpressure_inc(&mut self) -> u32

Available on crate feature component-model only.

Declares a new backpressure.inc intrinsic.

pub fn backpressure_dec(&mut self) -> u32

Available on crate feature component-model only.

Declares a new backpressure.dec intrinsic.

pub fn task_return<O>( &mut self, ty: Option<ComponentValType>, options: O, ) -> u32

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

Available on crate feature component-model only.

Declares a new task.return intrinsic.

pub fn task_cancel(&mut self) -> u32

Available on crate feature component-model only.

Declares a new task.cancel intrinsic.

pub fn context_get(&mut self, i: u32) -> u32

Available on crate feature component-model only.

Declares a new context.get intrinsic.

pub fn context_set(&mut self, i: u32) -> u32

Available on crate feature component-model only.

Declares a new context.set intrinsic.

pub fn thread_yield(&mut self, cancellable: bool) -> u32

Available on crate feature component-model only.

Declares a new thread.yield intrinsic.

pub fn subtask_drop(&mut self) -> u32

Available on crate feature component-model only.

Declares a new subtask.drop intrinsic.

pub fn subtask_cancel(&mut self, async_: bool) -> u32

Available on crate feature component-model only.

Declares a new subtask.cancel intrinsic.

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

Available on crate feature component-model only.

Declares a new stream.new intrinsic.

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

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

Available on crate feature component-model only.

Declares a new stream.read intrinsic.

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

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

Available on crate feature component-model only.

Declares a new stream.write intrinsic.

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

Available on crate feature component-model only.

Declares a new stream.cancel-read intrinsic.

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

Available on crate feature component-model only.

Declares a new stream.cancel-write intrinsic.

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

Available on crate feature component-model only.

Declares a new stream.drop-readable intrinsic.

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

Available on crate feature component-model only.

Declares a new stream.drop-writable intrinsic.

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

Available on crate feature component-model only.

Declares a new future.new intrinsic.

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

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

Available on crate feature component-model only.

Declares a new future.read intrinsic.

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

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

Available on crate feature component-model only.

Declares a new future.write intrinsic.

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

Available on crate feature component-model only.

Declares a new future.cancel-read intrinsic.

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

Available on crate feature component-model only.

Declares a new future.cancel-write intrinsic.

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

Available on crate feature component-model only.

Declares a new future.drop-readable intrinsic.

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

Available on crate feature component-model only.

Declares a new future.drop-writable intrinsic.

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

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

Available on crate feature component-model only.

Declares a new error-context.new intrinsic.

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

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

Available on crate feature component-model only.

Declares a new error-context.debug-message intrinsic.

pub fn error_context_drop(&mut self) -> u32

Available on crate feature component-model only.

Declares a new error-context.drop intrinsic.

pub fn waitable_set_new(&mut self) -> u32

Available on crate feature component-model only.

Declares a new waitable-set.new intrinsic.

pub fn waitable_set_wait(&mut self, cancellable: bool, memory: u32) -> u32

Available on crate feature component-model only.

Declares a new waitable-set.wait intrinsic.

pub fn waitable_set_poll(&mut self, cancellable: bool, memory: u32) -> u32

Available on crate feature component-model only.

Declares a new waitable-set.poll intrinsic.

pub fn waitable_set_drop(&mut self) -> u32

Available on crate feature component-model only.

Declares a new waitable-set.drop intrinsic.

pub fn waitable_join(&mut self) -> u32

Available on crate feature component-model only.

Declares a new waitable.join intrinsic.

pub fn thread_index(&mut self) -> u32

Available on crate feature component-model only.

Declares a new thread.index intrinsic.

pub fn thread_new_indirect(&mut self, func_ty_idx: u32, table_index: u32) -> u32

Available on crate feature component-model only.

Declares a new thread.new_indirect intrinsic.

pub fn thread_switch_to(&mut self, cancellable: bool) -> u32

Available on crate feature component-model only.

Declares a new thread.switch-to intrinsic.

pub fn thread_suspend(&mut self, cancellable: bool) -> u32

Available on crate feature component-model only.

Declares a new thread.suspend intrinsic.

pub fn thread_resume_later(&mut self) -> u32

Available on crate feature component-model only.

Declares a new thread.resume-later intrinsic.

pub fn thread_yield_to(&mut self, cancellable: bool) -> u32

Available on crate feature component-model only.

Declares a new thread.yield-to intrinsic.

pub fn custom_section(&mut self, section: &CustomSection<'_>)

Available on crate feature component-model only.

Adds a new custom section to this component.

pub fn raw_custom_section(&mut self, section: &[u8])

Available on crate feature component-model only.

Adds a new custom section to this component.

Trait Implementations

impl Debug for ComponentBuilder

Available on crate feature component-model only.

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

Formats the value using the given formatter.

impl Default for ComponentBuilder

Available on crate feature component-model only.

fn default() -> ComponentBuilder

Returns the “default value” for a type.