mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
72 lines
20 KiB
HTML
72 lines
20 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `WasmDecoder` trait in crate `wasmparser`."><meta name="keywords" content="rust, rustlang, rust-lang, WasmDecoder"><title>wasmparser::WasmDecoder - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../wasmparser/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait WasmDecoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.create_binary_reader">create_binary_reader</a><a href="#tymethod.last_state">last_state</a><a href="#tymethod.push_input">push_input</a><a href="#tymethod.read">read</a><a href="#tymethod.read_with_input">read_with_input</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>wasmparser</a></p><script>window.sidebarCurrent = {name: 'WasmDecoder', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/wasmparser/parser.rs.html#150-158' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>wasmparser</a>::<wbr><a class="trait" href=''>WasmDecoder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait WasmDecoder<'a> {
|
||
fn <a href='#tymethod.read' class='fnname'>read</a>(&mut self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.push_input' class='fnname'>push_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.read_with_input' class='fnname'>read_with_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.create_binary_reader' class='fnname'>create_binary_reader</a><'b>(&mut self) -> <a class="struct" href="../wasmparser/struct.BinaryReader.html" title="struct wasmparser::BinaryReader">BinaryReader</a><'b><br> <span class="where">where<br> 'a: 'b</span>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.last_state' class='fnname'>last_state</a>(&self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a>;
|
||
}</pre></div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.read' class='method'><code id='read.v'>fn <a href='#tymethod.read' class='fnname'>read</a>(&mut self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code></h3><h3 id='tymethod.push_input' class='method'><code id='push_input.v'>fn <a href='#tymethod.push_input' class='fnname'>push_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>)</code></h3><h3 id='tymethod.read_with_input' class='method'><code id='read_with_input.v'>fn <a href='#tymethod.read_with_input' class='fnname'>read_with_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code></h3><h3 id='tymethod.create_binary_reader' class='method'><code id='create_binary_reader.v'>fn <a href='#tymethod.create_binary_reader' class='fnname'>create_binary_reader</a><'b>(&mut self) -> <a class="struct" href="../wasmparser/struct.BinaryReader.html" title="struct wasmparser::BinaryReader">BinaryReader</a><'b> <span class="where fmt-newline">where<br> 'a: 'b, </span></code></h3><h3 id='tymethod.last_state' class='method'><code id='last_state.v'>fn <a href='#tymethod.last_state' class='fnname'>last_state</a>(&self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code></h3></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-WasmDecoder%3C%27a%3E' class='impl'><code class='in-band'>impl<'a> WasmDecoder<'a> for <a class="struct" href="../wasmparser/struct.Parser.html" title="struct wasmparser::Parser">Parser</a><'a></code><a href='#impl-WasmDecoder%3C%27a%3E' class='anchor'></a><a class='srclink' href='../src/wasmparser/parser.rs.html#1030-1155' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.read' class="method"><code id='read.v-1'>fn <a href='#method.read' class='fnname'>read</a>(&mut self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/parser.rs.html#1050-1056' title='goto source code'>[src]</a></h4><div class='docblock'><p>Reads next record from the WebAssembly binary data. The methods returns
|
||
reference to current state of the parser. See <code>ParserState</code> num.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">wasmparser</span>::<span class="ident">WasmDecoder</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">wasmparser</span>::<span class="ident">Parser</span>::<span class="ident">new</span>(<span class="ident">data</span>);
|
||
{
|
||
<span class="kw">let</span> <span class="ident">state</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">read</span>();
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"First state {:?}"</span>, <span class="ident">state</span>);
|
||
}
|
||
{
|
||
<span class="kw">let</span> <span class="ident">state</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">read</span>();
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Second state {:?}"</span>, <span class="ident">state</span>);
|
||
}</pre></div>
|
||
</div><h4 id='method.push_input' class="method hidden"><code id='push_input.v-1'>fn <a href='#method.push_input' class='fnname'>push_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>)</code><a class='srclink' href='../src/wasmparser/parser.rs.html#1058-1066' title='goto source code'>[src]</a></h4><h4 id='method.create_binary_reader' class="method"><code id='create_binary_reader.v-1'>fn <a href='#method.create_binary_reader' class='fnname'>create_binary_reader</a><'b>(&mut self) -> <a class="struct" href="../wasmparser/struct.BinaryReader.html" title="struct wasmparser::BinaryReader">BinaryReader</a><'b> <span class="where fmt-newline">where<br> 'a: 'b, </span></code><a class='srclink' href='../src/wasmparser/parser.rs.html#1100-1117' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a BinaryReader when current state is ParserState::BeginSection
|
||
or ParserState::BeginFunctionBody.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">wasmparser</span>::{<span class="ident">WasmDecoder</span>, <span class="ident">Parser</span>, <span class="ident">ParserState</span>};
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">Parser</span>::<span class="ident">new</span>(<span class="ident">data</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">function_readers</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">new</span>();
|
||
<span class="kw">loop</span> {
|
||
<span class="kw">match</span> <span class="kw-2">*</span><span class="ident">parser</span>.<span class="ident">read</span>() {
|
||
<span class="ident">ParserState</span>::<span class="ident">Error</span>(<span class="kw">_</span>) <span class="op">|</span>
|
||
<span class="ident">ParserState</span>::<span class="ident">EndWasm</span> <span class="op">=</span><span class="op">></span> <span class="kw">break</span>,
|
||
<span class="ident">ParserState</span>::<span class="ident">BeginFunctionBody</span> {..} <span class="op">=</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">reader</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">create_binary_reader</span>();
|
||
<span class="ident">function_readers</span>.<span class="ident">push</span>(<span class="ident">reader</span>);
|
||
}
|
||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="kw">continue</span>
|
||
}
|
||
}
|
||
<span class="kw">for</span> (<span class="ident">i</span>, <span class="ident">reader</span>) <span class="kw">in</span> <span class="ident">function_readers</span>.<span class="ident">iter_mut</span>().<span class="ident">enumerate</span>() {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Function {}"</span>, <span class="ident">i</span>);
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="kw-2">ref</span> <span class="ident">op</span>) <span class="op">=</span> <span class="ident">reader</span>.<span class="ident">read_operator</span>() {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">" {:?}"</span>, <span class="ident">op</span>);
|
||
}
|
||
}</pre></div>
|
||
</div><h4 id='method.read_with_input' class="method"><code id='read_with_input.v-1'>fn <a href='#method.read_with_input' class='fnname'>read_with_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/parser.rs.html#1147-1150' title='goto source code'>[src]</a></h4><div class='docblock'><p>Reads next record from the WebAssembly binary data. It also allows to
|
||
control how parser will treat the next record(s). The method accepts the
|
||
<code>ParserInput</code> parameter that allows e.g. to skip section or function
|
||
operators. The methods returns reference to current state of the parser.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">wasmparser</span>::<span class="ident">WasmDecoder</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">wasmparser</span>::<span class="ident">Parser</span>::<span class="ident">new</span>(<span class="ident">data</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">next_input</span> <span class="op">=</span> <span class="ident">wasmparser</span>::<span class="ident">ParserInput</span>::<span class="ident">Default</span>;
|
||
<span class="kw">loop</span> {
|
||
<span class="kw">let</span> <span class="ident">state</span> <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">read_with_input</span>(<span class="ident">next_input</span>);
|
||
<span class="kw">match</span> <span class="kw-2">*</span><span class="ident">state</span> {
|
||
<span class="ident">wasmparser</span>::<span class="ident">ParserState</span>::<span class="ident">EndWasm</span> <span class="op">=</span><span class="op">></span> <span class="kw">break</span>,
|
||
<span class="ident">wasmparser</span>::<span class="ident">ParserState</span>::<span class="ident">BeginWasm</span> { .. } <span class="op">|</span>
|
||
<span class="ident">wasmparser</span>::<span class="ident">ParserState</span>::<span class="ident">EndSection</span> <span class="op">=</span><span class="op">></span>
|
||
<span class="ident">next_input</span> <span class="op">=</span> <span class="ident">wasmparser</span>::<span class="ident">ParserInput</span>::<span class="ident">Default</span>,
|
||
<span class="ident">wasmparser</span>::<span class="ident">ParserState</span>::<span class="ident">BeginSection</span> { <span class="kw-2">ref</span> <span class="ident">code</span>, .. } <span class="op">=</span><span class="op">></span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Found section: {:?}"</span>, <span class="ident">code</span>);
|
||
<span class="ident">next_input</span> <span class="op">=</span> <span class="ident">wasmparser</span>::<span class="ident">ParserInput</span>::<span class="ident">SkipSection</span>;
|
||
},
|
||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>()
|
||
}
|
||
}</pre></div>
|
||
</div><h4 id='method.last_state' class="method hidden"><code id='last_state.v-1'>fn <a href='#method.last_state' class='fnname'>last_state</a>(&self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/parser.rs.html#1152-1154' title='goto source code'>[src]</a></h4></div><h3 id='impl-WasmDecoder%3C%27a%3E-1' class='impl'><code class='in-band'>impl<'a> WasmDecoder<'a> for <a class="struct" href="../wasmparser/struct.ValidatingParser.html" title="struct wasmparser::ValidatingParser">ValidatingParser</a><'a></code><a href='#impl-WasmDecoder%3C%27a%3E-1' class='anchor'></a><a class='srclink' href='../src/wasmparser/validator.rs.html#645-690' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.read-1' class="method hidden"><code id='read.v-2'>fn <a href='#method.read-1' class='fnname'>read</a>(&mut self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/validator.rs.html#646-654' title='goto source code'>[src]</a></h4><h4 id='method.push_input-1' class="method hidden"><code id='push_input.v-2'>fn <a href='#method.push_input-1' class='fnname'>push_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>)</code><a class='srclink' href='../src/wasmparser/validator.rs.html#656-666' title='goto source code'>[src]</a></h4><h4 id='method.read_with_input-1' class="method hidden"><code id='read_with_input.v-2'>fn <a href='#method.read_with_input-1' class='fnname'>read_with_input</a>(&mut self, input: <a class="enum" href="../wasmparser/enum.ParserInput.html" title="enum wasmparser::ParserInput">ParserInput</a>) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/validator.rs.html#668-671' title='goto source code'>[src]</a></h4><h4 id='method.create_binary_reader-1' class="method hidden"><code id='create_binary_reader.v-2'>fn <a href='#method.create_binary_reader-1' class='fnname'>create_binary_reader</a><'b>(&mut self) -> <a class="struct" href="../wasmparser/struct.BinaryReader.html" title="struct wasmparser::BinaryReader">BinaryReader</a><'b> <span class="where fmt-newline">where<br> 'a: 'b, </span></code><a class='srclink' href='../src/wasmparser/validator.rs.html#673-681' title='goto source code'>[src]</a></h4><h4 id='method.last_state-1' class="method hidden"><code id='last_state.v-2'>fn <a href='#method.last_state-1' class='fnname'>last_state</a>(&self) -> &<a class="enum" href="../wasmparser/enum.ParserState.html" title="enum wasmparser::ParserState">ParserState</a><'a></code><a class='srclink' href='../src/wasmparser/validator.rs.html#683-689' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/wasmparser/trait.WasmDecoder.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "wasmparser";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |