Crate wasmparser

Expand description

A simple event-driven library for parsing WebAssembly binary files (or streams).

The parser library reports events as they happen and only stores parsing information for a brief period of time, making it very fast and memory-efficient. The event-driven model, however, has some drawbacks. If you need random access to the entire WebAssembly data-structure, this is not the right library for you. You could however, build such a data-structure using this library.

To get started, create a Parser using Parser::new and then follow the examples documented for Parser::parse or Parser::parse_all.

Macros§

for_each_operator: Used to implement routines for the Operator enum.
for_each_visit_operator: Used to implement the VisitOperator trait.

Structs§

ArrayType: Represents a type of an array in a WebAssembly module.
BinaryReader: A binary reader of the WebAssembly structures and types.
BinaryReaderError: A binary reader for WebAssembly modules.
BrTable: A br_table entries representation.
BranchHint: A hint for a single branch.
BranchHintFunction: Branch hints for a single function.
Comdat: Represents COMDAT data in the linking custom section.
ComdatSymbol: Represents a symbol that is part of a comdat.
CompositeType: Represents a composite type in a WebAssembly module.
ConstExpr: Represents an initialization expression.
ContType: Represents a type of a continuation in a WebAssembly module.
CoreDumpInstance: A single instance from a coredump instances section
CoreDumpInstancesSection: A custom section representing the instances involved in a given coredump
CoreDumpModulesSection: The data portion of a “coremodules” custom section. This contains a vec of module names that will be referenced by index by other coredump sections.
CoreDumpSection: The data portion of a custom section representing a core dump. Per the tool-conventions repo, this section just specifies the executable name that the core dump came from while the rest of the core dump information is contained in a corestack custom section
CoreDumpStackFrame: A single stack frame from a core dump
CoreDumpStackSection: The data portion of a custom section representing a core dump stack. The structure of this follows the coredump spec in the tool-conventions repo
CustomSectionReader: A reader for custom sections of a WebAssembly module.
Data: Represents a data segment in a core WebAssembly module.
DefinedDataSymbol: Represents the metadata about a data symbol defined in the wasm file.
Element: Represents a core WebAssembly element segment.
Export: Represents an export in a WebAssembly module.
ExportInfo
FieldType: Represents a field type of an array or a struct.
FuncType: Represents a type of a function in a WebAssembly module.
FunctionBody: Represents a WebAssembly function body.
Global: Represents a core WebAssembly global.
GlobalType: Represents a global’s type.
Ieee32: An IEEE binary32 immediate floating point value, represented as a u32 containing the bit pattern.
Ieee64: An IEEE binary64 immediate floating point value, represented as a u64 containing the bit pattern.
Import: Represents an import in a WebAssembly module.
ImportInfo
IndirectNaming: Represents an indirect name in the names custom section.
InitFunc: Represents an init function in the linking custom section.
LinkingSectionReader: A reader for the linking custom section of a WebAssembly module.
LocalsIterator: An iterator over locals in a function body.
LocalsReader: A reader for a function body’s locals.
MemArg: Represents a memory immediate in a WebAssembly memory instruction.
MemInfo: Represents a WASM_DYLINK_MEM_INFO field
MemoryType: Represents a memory’s type.
Naming: Represents a name for an index from the names section.
OperatorsIterator: An iterator over a function’s operators.
OperatorsIteratorWithOffsets: An iterator over a function’s operators with offsets.
OperatorsReader: A reader for a core WebAssembly function’s operators.
PackedIndex: A packed representation of a type index.
Parser: An incremental parser of a binary WebAssembly module or component.
ProducersField: A field from the producers custom section.
ProducersFieldValue: Represents a field value in the producers custom section.
RecGroup: Represents a recursive type group in a WebAssembly module.
RefType: A reference type.
RelocSectionReader: Reader for reloc.* sections as defined by https://github.com/WebAssembly/tool-conventions/blob/main/Linking.md#relocation-sections.
RelocationEntry: Single relocation entry within a reloc.* section, as defined at https://github.com/WebAssembly/tool-conventions/blob/main/Linking.md#relocation-sections.
ResumeTable: A representation of dispatch tables on resume and resume_throw instructions.
SectionLimited: A generic structure for reading a section of a WebAssembly binary which has a limited number of items within it.
SectionLimitedIntoIter: A consuming iterator of a SectionLimited.
SectionLimitedIntoIterWithOffsets: An iterator over a limited section iterator.
Segment: Represents extra metadata about the data segments.
SegmentFlags: Flags for WebAssembly segments.
StructType: Represents a type of a struct in a WebAssembly module.
SubType: Represents a subtype of possible other types in a WebAssembly module.
Subsections: Iterator/reader over the contents of a section which is composed of subsections.
SymbolFlags: Flags for WebAssembly symbols.
Table: Type information about a table defined in the table section of a WebAssembly module.
TableType: Represents a table’s type.
TagType: A tag’s type.
TryTable: A try_table entries representation.
V128: Represents a 128-bit vector value.
WasmFeatures: Enabled WebAssembly proposals and features.

Enums§

AbstractHeapType: An abstract heap type.
BlockType: Represents a block type.
Catch: Catch clauses that can be specified in TryTable.
Chunk: A successful return payload from Parser::parse.
ComdatSymbolKind: Represents a symbol kind.
CompositeInnerType: A CompositeType can contain one of these types.
CoreDumpValue: Local and stack values are encoded using one byte for the type (similar to Wasm’s Number Types) followed by bytes representing the actual value See the tool-conventions repo for more details.
DataKind: The kind of data segment.
Dylink0Subsection: Possible subsections of the dylink.0 custom section.
ElementItems: Represents the items of an element segment.
ElementKind: The kind of element segment.
Encoding: The supported encoding formats for the parser.
ExternalKind: External types as defined here.
FrameKind: The kind of a control flow Frame.
Handle: Handle clauses that can be specified in ResumeTable.
HeapType: A heap type.
KnownCustom: Return value of CustomSectionReader::as_known.
Linking: Represents a subsection read from the linking custom section.
Name: Represents a name read from the names custom section.
Operator: Instructions as defined here.
Ordering: Represents the memory ordering for atomic instructions.
Payload: Values that can be parsed from a WebAssembly module or component.
RelocAddendKind: Indicates the kind of addend that applies to a relocation entry.
RelocationType: Relocation entry type. Each entry type corresponds to one of the R_WASM_* constants defined at https://github.com/llvm/llvm-project/blob/main/llvm/include/llvm/BinaryFormat/WasmRelocs.def and https://github.com/WebAssembly/tool-conventions/blob/main/Linking.md#relocation-sections.
StorageType: Represents storage types introduced in the GC spec for array and struct fields.
SymbolInfo: Represents extra information about symbols in the linking custom section.
TableInit: Different modes of initializing a table.
TagKind: Represents a tag kind.
TypeRef: Represents a reference to a type definition in a WebAssembly module.
UnpackedIndex: The uncompressed form of a PackedIndex.
ValType: Represents the types of values in a WebAssembly module.

Traits§

FromReader: A trait implemented for items that can be decoded directly from a BinaryReader, or that which can be parsed from the WebAssembly binary format.
ModuleArity: To compute the arity (param and result counts) of “variable-arity” operators, the operator_arity macro needs information about the module’s types and the current control stack. The ModuleArity trait exposes this information.
Subsection: A trait implemented for subsections of another outer section.
VisitOperator: Trait implemented by types that can visit all Operator variants.

Type Aliases§