Crate cranelift_wasm::wasmparser

source ·
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.

Modules

  • types
    Types relating to type information provided by validation.

Macros

  • for_each_operator
    A helper macro to conveniently iterate over all opcodes recognized by this crate. This can be used to work with either the Operator enumeration or the VisitOperator trait if your use case uniformly handles all operators the same way.

Structs

  • BinaryReader
    A binary reader of the WebAssembly structures and types.
  • BinaryReaderError
    A binary reader for WebAssembly modules.
  • BrTable
    A br_table entries representation.
  • ComponentExport
    Represents an export in a WebAssembly component.
  • ComponentFuncType
    Represents a type of a function in a WebAssembly component.
  • ComponentImport
    Represents an import in a WebAssembly component
  • ComponentInstantiationArg
    Represents an argument to instantiating a WebAssembly component.
  • ComponentStartFunction
    Represents the start function in a WebAssembly component.
  • ConstExpr
    Represents an initialization expression.
  • CustomSectionReader
    A reader for custom sections of a WebAssembly module.
  • Data
    Represents a data segment in a core WebAssembly module.
  • Element
    Represents a core WebAssembly element segment.
  • Export
    Represents an export in a WebAssembly module.
  • Frame
    A Wasm control flow block on the control flow stack during Wasm validation.
  • FuncToValidate
    Resources necessary to perform validation of a function.
  • FuncType
    Represents a type of a function in a WebAssembly module.
  • FuncValidator
    Validation context for a WebAssembly function.
  • FuncValidatorAllocations
    External handle to the internal allocations used during function validation.
  • 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.
  • IndirectNaming
    Represents an indirect name in the names custom section.
  • InstantiationArg
    Represents an argument to instantiating 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.
  • 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
    Used as a performance optimization in HeapType. Call .into() to get the u32
  • 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.
  • RefType
    A reference type. When the function references feature is disabled, this only represents funcref and externref, using the following format: RefType { nullable: true, heap_type: Func | Extern })
  • 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.
  • Subsections
    Iterator/reader over the contents of a section which is composed of subsections.
  • 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.
  • V128
    Represents a 128-bit vector value.
  • Validator
    Validator for a WebAssembly binary module or component.
  • ValidatorResources
    The implementation of WasmModuleResources used by Validator.
  • VariantCase
    Represents a case in a variant type.
  • WasmFeatures
    Flags for features that are enabled for validation.
  • WasmFuncTypeInputs
    Iterator over the inputs of a Wasm function type.
  • WasmFuncTypeOutputs
    Iterator over the outputs of a Wasm function type.

Enums

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.
  • Subsection
    A trait implemented for subsections of another outer section.
  • VisitOperator
    Trait implemented by types that can visit all Operator variants.
  • WasmFuncType
    Types that qualify as Wasm function types for validation purposes.
  • WasmModuleResources
    Types that qualify as Wasm validation database.

Functions

Type Definitions