Struct NameSection

pub struct NameSection { /* private fields */ }

An encoder for the custom name section.

Example

use wasm_encoder::{Module, NameSection, NameMap};

let mut names = NameSection::new();
names.module("the module name");

let mut function_names = NameMap::new();
function_names.append(0, "name of function 0");
function_names.append(1, "a better function");
function_names.append(3, "the best function");
names.functions(&function_names);

let mut module = Module::new();
module.section(&names);

let wasm_bytes = module.finish();

Implementations

impl NameSection

pub fn new() -> Self

Creates a new blank name custom section.

pub fn module(&mut self, name: &str)

Appends a module name subsection to this section.

This will indicate that the name of the entire module should be the name specified. Note that this should be encoded first before other subsections.

pub fn functions(&mut self, names: &NameMap)

Appends a subsection for the names of all functions in this wasm module.

Function names are declared in the names map provided where the index in the map corresponds to the wasm index of the function. This section should come after the module name subsection (if present) and before the locals subsection (if present).

pub fn locals(&mut self, names: &IndirectNameMap)

Appends a subsection for the names of locals within functions in this wasm module.

This section should come after the function name subsection (if present) and before the labels subsection (if present).

pub fn labels(&mut self, names: &IndirectNameMap)

Appends a subsection for the names of labels within functions in this wasm module.

This section should come after the local name subsection (if present) and before the type subsection (if present).

pub fn types(&mut self, names: &NameMap)

Appends a subsection for the names of all types in this wasm module.

This section should come after the label name subsection (if present) and before the table subsection (if present).

pub fn tables(&mut self, names: &NameMap)

Appends a subsection for the names of all tables in this wasm module.

This section should come after the type name subsection (if present) and before the memory subsection (if present).

pub fn memories(&mut self, names: &NameMap)

Appends a subsection for the names of all memories in this wasm module.

This section should come after the table name subsection (if present) and before the global subsection (if present).

pub fn globals(&mut self, names: &NameMap)

Appends a subsection for the names of all globals in this wasm module.

This section should come after the memory name subsection (if present) and before the element subsection (if present).

pub fn elements(&mut self, names: &NameMap)

Appends a subsection for the names of all elements in this wasm module.

This section should come after the global name subsection (if present) and before the data subsection (if present).

pub fn data(&mut self, names: &NameMap)

Appends a subsection for the names of all data in this wasm module.

This section should come after the element name subsection (if present) and before the field subsection (if present).

pub fn tag(&mut self, names: &NameMap)

Appends a subsection for the names of all tags in this wasm module.

This section should come after the data name subsection (if present).

pub fn fields(&mut self, names: &IndirectNameMap)

Appends a subsection for the names of fields within types in this wasm module.

This section should come after the data name subsection (if present) and before the tag subsection (if present).

pub fn tags(&mut self, names: &NameMap)

Appends a subsection for the names of all tags in this wasm module.

This section should come after the field name subsection (if present).

pub fn raw(&mut self, id: u8, data: &[u8])

Appends a raw subsection with the given id and data.

pub fn as_custom<'a>(&'a self) -> CustomSection<'a>

View the encoded section as a CustomSection.

Trait Implementations

impl Clone for NameSection

fn clone(&self) -> NameSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NameSection

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

Formats the value using the given formatter.

impl Default for NameSection

fn default() -> NameSection

Returns the “default value” for a type.

impl Encode for NameSection

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

Encode the type into the given byte sink.

impl Section for NameSection

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.