Struct wasmprinter::Printer

pub struct Printer { /* private fields */ }

Context used for printing a WebAssembly binary.

This is largely only required if you’d like to register custom printers for custom sections in a wasm binary.

Implementations

impl Printer

pub fn new() -> Self

Creates a new Printer object that’s ready to start printing wasm binaries to strings.

pub fn print_offsets(&mut self, print: bool)

Whether or not to print binary offsets of each item as comments in the text format whenever a newline is printed.

pub fn print_skeleton(&mut self, print: bool)

Whether or not to print only a “skeleton” which skips function bodies, data segment contents, element segment contents, etc.

pub fn name_unnamed(&mut self, enable: bool)

Assign names to all unnamed items.

If enabled then any previously unnamed item will have a name synthesized that looks like $#func10 for example. The leading # indicates that it’s wasmprinter-generated. The func is the namespace of the name and provides extra context about the item when referenced. The 10 is the local index of the item.

Note that if the resulting text output is converted back to binary the resulting name custom section will not be the same as before.

pub fn add_custom_section_printer( &mut self, section: &str, printer: impl FnMut(&mut Printer, usize, &[u8]) -> Result<()> + 'static )

Registers a custom printer function to get invoked whenever a custom section of name section is seen.

This can be used to register printers into a textual format for custom sections, such as by emitting annotations and/or other textual references (maybe comments!)

By default all custom sections are ignored for the text format.

The printer function provided takes three arguments:

• A &mut Printer, or where to print results to
• A usize offset which is the start of the offset for the custom section
• A byte slice which is the actual contents of the custom section.

pub fn result_mut(&mut self) -> &mut String

Gets the output result of this Printer, or where all output is going.

pub fn print(&mut self, wasm: &[u8]) -> Result<String>

Prints a WebAssembly binary into a String

This function takes an entire wasm binary blob and will print it to the WebAssembly Text Format and return the result as a String.

pub fn offsets_and_lines<'a>( &'a mut self, wasm: &[u8] ) -> Result<impl Iterator<Item = (Option<usize>, &'a str)> + 'a>

Get the line-by-line WAT disassembly for the given Wasm, along with the binary offsets for each line.

Trait Implementations

impl Default for Printer

fn default() -> Printer

Returns the “default value” for a type.