Struct golem_wasm_ast::core::Module

pub struct Module<Ast: AstCustomization + 'static> { /* private fields */ }

The top-level AST node representing a core WASM module

Some parts of the AST are customizable by the Ast type parameter. See AstCustomization for more details.

Implementations

impl<Ast> Module<Ast>

where Ast: AstCustomization + 'static, Ast::Expr: TryFromExprSource, Ast::Data: From<Data<Ast::Expr>>, Ast::Custom: From<Custom>,

pub fn from_bytes(bytes: &[u8]) -> Result<Self, String>

Parses a module from a binary WASM byte array

impl<Ast> Module<Ast>

where Ast: AstCustomization + 'static, Ast::Expr: RetainsInstructions, Ast::Data: Into<Data<Ast::Expr>>, Ast::Custom: Into<Custom>,

pub fn into_bytes(self) -> Result<Vec<u8>, String>

Serializes the module into a binary WASM byte array

impl<Ast: AstCustomization> Module<Ast>

pub fn empty() -> Self

Creates an empty module

pub fn types(&self) -> Vec<Mrc<FuncType>>

Gets all the function types in the module

pub fn func_type_refs(&self) -> Vec<Mrc<FuncTypeRef>>

Gets all the function type references in the module

A more useful function is [funcs] that combines this and [codes] together.

pub fn codes(&self) -> Vec<Mrc<FuncCode<Ast::Expr>>>

Gets all the function codes in the module.

A more useful function is [funcs] that combines this and [codes] together.

pub fn funcs(&self) -> Vec<Func<Ast::Expr>>

Gets all the functions defined in the module

pub fn tables(&self) -> Vec<Mrc<Table>>

Gets all the tables defined in the module

pub fn mems(&self) -> Vec<Mrc<Mem>>

Gets all the memories defined in the module

pub fn globals(&self) -> Vec<Mrc<Global>>

Gets all the globals defined in the module

pub fn elems(&self) -> Vec<Mrc<Elem<Ast::Expr>>>

Gets all the elems defined in the module

pub fn datas(&self) -> Vec<Mrc<Ast::Data>>

Gets all the data sections defined in the module

pub fn start(&self) -> Option<Mrc<Start>>

Gets the start section of the module

pub fn imports(&self) -> Vec<Mrc<Import>>

Gets all the imports of the module

pub fn exports(&self) -> Vec<Mrc<Export>>

Gets all the exports of the module

pub fn customs(&self) -> Vec<Mrc<Ast::Custom>>

Gets all the custom sections of the module

pub fn add_data(&mut self, data: Ast::Data)

Adds a new data section

pub fn add_elem(&mut self, elem: Elem<Ast::Expr>)

Adds a new elem

pub fn add_export(&mut self, export: Export)

Adds a new export

pub fn add_function( &mut self, func_type: FuncType, locals: Vec<ValType>, body: Ast::Expr, ) -> FuncIdx

Adds a new function

pub fn add_global(&mut self, global: Global)

Adds a new global

pub fn add_memory(&mut self, mem: Mem)

Adds a new memory

pub fn add_table(&mut self, table: Table)

Adds a new table

pub fn add_type(&mut self, func_type: FuncType)

Adds a new function type

pub fn get_code( &mut self, func_idx: FuncIdx, ) -> Option<Mrc<FuncCode<Ast::Expr>>>

Gets a function body by its index

pub fn get_data(&mut self, data_idx: DataIdx) -> Option<Mrc<Ast::Data>>

Gets a data section by its index

pub fn get_elem(&mut self, elem_idx: ElemIdx) -> Option<Mrc<Elem<Ast::Expr>>>

Gets an elem by its index

pub fn get_export(&mut self, export_idx: ExportIdx) -> Option<Mrc<Export>>

Gets an export by its index

pub fn get_function( &mut self, func_idx: FuncIdx, ) -> Option<ImportOrFunc<Ast::Expr>>

Gets a function by its index

In a core WASM module the function index space holds both defined functions and imported functions.

pub fn get_global(&mut self, global_idx: GlobalIdx) -> Option<Mrc<Global>>

Gets a global by its index

pub fn get_memory(&mut self, mem_idx: MemIdx) -> Option<Mrc<Mem>>

Gets a memory by its index

pub fn get_table(&mut self, table_idx: TableIdx) -> Option<Mrc<Table>>

Gets a table by its index

pub fn type_idx_of(&self, func_type: &FuncType) -> Option<TypeIdx>

Checks whether a given function type is already defined in the module, and returs its type index if so.

pub fn into_sections(self) -> Vec<Mrc<CoreSection<Ast>>>

Converts the module into a sequence of sections

pub fn into_grouped(self) -> Vec<(CoreSectionType, Vec<Mrc<CoreSection<Ast>>>)>

Converts the module into a grouped sequence of sections, exactly as it should be written to a binary WASM file

impl<Ast> Module<Ast>

where Ast: AstCustomization, Ast::Custom: RetainsCustomSection,

pub fn get_metadata(&self) -> Option<Metadata>

Gets all the metadata supported by the wasm-metadata crate defined in this module’s custom sections

Trait Implementations

impl<Ast: AstCustomization> Clone for Module<Ast>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ast: AstCustomization> Debug for Module<Ast>

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

Formats the value using the given formatter.

impl<Ast: AstCustomization> PartialEq for Module<Ast>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<Ast: AstCustomization> Section<ComponentIndexSpace, ComponentSectionType> for Module<Ast>

fn index_space(&self) -> ComponentIndexSpace

fn section_type(&self) -> ComponentSectionType

impl<Ast> TryFrom<(Parser, &[u8])> for Module<Ast>

where Ast: AstCustomization, Ast::Expr: TryFromExprSource, Ast::Data: From<Data<Ast::Expr>>, Ast::Custom: From<Custom>,

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: (Parser, &[u8])) -> Result<Self, Self::Error>

Performs the conversion.

impl<Ast> TryFrom<Module<Ast>> for Module

where Ast: AstCustomization, Ast::Expr: RetainsInstructions, Ast::Data: Into<Data<Ast::Expr>>, Ast::Custom: Into<Custom>,

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: Module<Ast>) -> Result<Self, Self::Error>

Performs the conversion.