Struct wasm_encoder::BranchHints

pub struct BranchHints { /* private fields */ }

Helper structure to encode the metadata.code.branch_hint custom section.

This section was defined in the branch-hinting proposal for WebAssembly: https://github.com/WebAssembly/branch-hinting.

Example

use wasm_encoder::*;

let mut module = Module::new();

let mut types = TypeSection::new();
types.ty().function([], []);
module.section(&types);

let mut funcs = FunctionSection::new();
funcs.function(0);
module.section(&funcs);

let mut code = CodeSection::new();
let mut body = Function::new([]);

body.instruction(&Instruction::I32Const(1));
let if_offset = body.byte_len();
body.instruction(&Instruction::If(BlockType::Empty));
body.instruction(&Instruction::End);
body.instruction(&Instruction::End);
code.function(&body);

let mut hints = BranchHints::new();
hints.function_hints(0, [BranchHint {
    branch_func_offset: if_offset as u32,
    branch_hint_value: 1, // taken
}]);
module.section(&hints);
module.section(&code);

let wasm = module.finish();
let wat = wasmprinter::print_bytes(&wasm).unwrap();
assert_eq!(wat, r#"(module
  (type (;0;) (func))
  (func (;0;) (type 0)
    i32.const 1
    (@metadata.code.branch_hint "\01")
    if ;; label = @1
    end
  )
)
"#);

Implementations

impl BranchHints

pub fn new() -> Self

Construct an empty encoder for the branch hints custom section.

pub fn function_hints<I>(&mut self, func: u32, hints: I)

where I: IntoIterator<Item = BranchHint>, I::IntoIter: ExactSizeIterator,

Adds a new set of function hints for the func specified.

pub fn is_empty(&self) -> bool

Returns if this is an empty section.

pub fn len(&self) -> u32

Returns the number of functions that have hints registered in this sectino.

Trait Implementations

impl Debug for BranchHints

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

Formats the value using the given formatter.

impl Default for BranchHints

fn default() -> BranchHints

Returns the “default value” for a type.

impl Encode for BranchHints

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

Encode the type into the given byte sink.

impl Section for BranchHints

fn id(&self) -> u8

Gets the section identifier for this section.

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

Appends this section to the specified destination list of bytes.