third_party/rust/wasmparser/README.md

   1 # The WebAssembly binary file decoder in Rust
   2
   3 **A [Bytecode Alliance](https://bytecodealliance.org/) project**
   4
   5 [![crates.io link](https://img.shields.io/crates/v/wasmparser.svg)](https://crates.io/crates/wasmparser)
   6 [![docs.rs docs](https://img.shields.io/static/v1?label=docs&message=wasmparser&color=blue&style=flat-square)](https://docs.rs/wasmparser/)
   7
   8 The decoder library provides lightweight and fast decoding/parsing of WebAssembly binary files.
   9
  10 The other goal is minimal memory footprint. For this reason, there is no AST or IR of WebAssembly data.
  11
  12 See also its sibling at https://github.com/wasdk/wasmparser
  13
  14
  15 ## Documentation
  16
  17 The documentation and examples can be found at the https://docs.rs/wasmparser/
  18
  19
  20 ## Fuzzing
  21
  22 To fuzz test wasmparser.rs, switch to a nightly Rust compiler and install [cargo-fuzz]:
  23
  24 ```
  25 cargo install cargo-fuzz
  26 ```
  27
  28 Then, from the root of the repository, run:
  29
  30 ```
  31 cargo fuzz run parse
  32 ```
  33
  34 If you want to use files as seeds for the fuzzer, add them to `fuzz/corpus/parse/` and restart cargo-fuzz.
  35
  36 [cargo-fuzz]: https://github.com/rust-fuzz/cargo-fuzz