Struct parity_wasm::builder::ModuleBuilder

pub struct ModuleBuilder<F = Identity> { /* private fields */ }

Module builder

Implementations

impl ModuleBuilder

pub fn new() -> Self

New empty module builder

impl<F> ModuleBuilder<F> where
    F: Invoke<Module>, 

pub fn with_callback(callback: F) -> Self

New module builder with bound callback

pub fn with_module(self, module: Module) -> Self

Builder from raw module

pub fn with_sections<I>(self, sections: I) -> Self where
    I: IntoIterator<Item = Section>, 

Fill module with sections from iterator

pub fn with_section(self, section: Section) -> Self

Add additional section

pub fn with_signatures(self, bindings: Vec<Signature>) -> Self

Binds to the type section, creates additional types when required

pub fn push_function(&mut self, func: FunctionDefinition) -> CodeLocation

Push stand-alone function definition, creating sections, signature and code blocks in corresponding sections. FunctionDefinition can be build using builder::function builder

pub fn push_memory(&mut self, memory: MemoryDefinition) -> u32

Push linear memory region

pub fn push_table(&mut self, table: TableDefinition) -> u32

Push table

pub fn push_signature(&mut self, signature: Signature) -> u32

Push one function signature, returning it’s calling index. Can create corresponding type in type section.

pub fn push_signatures(&mut self, signatures: Vec<Signature>) -> Vec<u32>

Push signatures in the module, returning corresponding indices of pushed signatures

pub fn push_import(&mut self, import: ImportEntry) -> u32

Push import entry to module. Note that this does not update calling indices in function bodies.

pub fn push_export(&mut self, export: ExportEntry) -> u32

Push export entry to module.

pub fn function(self) -> FunctionBuilder<Self>

Add new function using dedicated builder

pub fn memory(self) -> MemoryBuilder<Self>

Add new linear memory using dedicated builder

pub fn table(self) -> TableBuilder<Self>

Add new table using dedicated builder

pub fn functions(self) -> SignaturesBuilder<Self>

Define functions section

pub fn with_export(self, entry: ExportEntry) -> Self

With inserted export entry

pub fn with_import(self, entry: ImportEntry) -> Self

With inserted import entry

pub fn import(self) -> ImportBuilder<Self>

Import entry builder

Examples

use parity_wasm::builder::module;

let module = module()
   .import()
       .module("env")
       .field("memory")
       .external().memory(256, Some(256))
       .build()
   .build();

assert_eq!(module.import_section().expect("import section to exist").entries().len(), 1);

pub fn with_global(self, global: GlobalEntry) -> Self

With global variable

pub fn with_table(self, table: TableType) -> Self

With table

pub fn export(self) -> ExportBuilder<Self>

Export entry builder

Examples

use parity_wasm::builder::module;
use parity_wasm::elements::Instruction::*;

let module = module()
   .global()
        .value_type().i32()
        .init_expr(I32Const(0))
        .build()
   .export()
       .field("_zero")
       .internal().global(0)
       .build()
   .build();

assert_eq!(module.export_section().expect("export section to exist").entries().len(), 1);

pub fn global(self) -> GlobalBuilder<Self>

Glboal entry builder

Examples

use parity_wasm::builder::module;
use parity_wasm::elements::Instruction::*;

let module = module()
   .global()
        .value_type().i32()
        .init_expr(I32Const(0))
        .build()
   .build();

assert_eq!(module.global_section().expect("global section to exist").entries().len(), 1);

pub fn with_data_segment(self, segment: DataSegment) -> Self

Add data segment to the builder

pub fn data(self) -> DataSegmentBuilder<Self>

Data entry builder

pub fn build(self) -> F::Result

Build module (final step)