mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-27 11:22:13 +00:00
66 lines
11 KiB
HTML
66 lines
11 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 `script` mod in crate `wabt`."><meta name="keywords" content="rust, rustlang, rust-lang, script"><title>wabt::script - 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 mod"><!--[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='../../wabt/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module script</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>wabt</a></p><script>window.sidebarCurrent = {name: 'script', ty: 'mod', 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/wabt/script/mod.rs.html#1-683' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>wabt</a>::<wbr><a class="mod" href=''>script</a></span></h1><div class='docblock'><p>Module for parsing <a href="https://github.com/WebAssembly/spec/blob/a25083ac7076b05e3f304ec9e093ef1b1ee09422/interpreter/README.md#scripts">WebAssembly script format</a> (a.k.a. wast).</p>
|
|||
|
|
<p>These scripts might be useful to integrate the official spec <a href="https://github.com/WebAssembly/testsuite">testsuite</a> into implementations
|
|||
|
|
of the wasm execution engines (such as <a href="https://github.com/pepyakin/wasmi">wasmi</a>) and for developing fine-grained tests of
|
|||
|
|
runtimes or/and if it isn't desired to use full fledged compilers.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">wabt</span>::<span class="ident">script</span>::{<span class="ident">ScriptParser</span>, <span class="ident">Command</span>, <span class="ident">CommandKind</span>, <span class="ident">Action</span>, <span class="ident">Value</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">wast</span> <span class="op">=</span> <span class="string">r#"
|
|||
|
|
;; Define anonymous module with function export named `sub`.
|
|||
|
|
(module
|
|||
|
|
(func (export "sub") (param $x i32) (param $y i32) (result i32)
|
|||
|
|
;; return x - y;
|
|||
|
|
(i32.sub
|
|||
|
|
(get_local $x) (get_local $y)
|
|||
|
|
)
|
|||
|
|
)
|
|||
|
|
)
|
|||
|
|
|
|||
|
|
;; Assert that invoking export `sub` with parameters (8, 3)
|
|||
|
|
;; should return 5.
|
|||
|
|
(assert_return
|
|||
|
|
(invoke "sub"
|
|||
|
|
(i32.const 8) (i32.const 3)
|
|||
|
|
)
|
|||
|
|
(i32.const 5)
|
|||
|
|
)
|
|||
|
|
"#</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">ScriptParser</span>::<span class="op"><</span><span class="ident">f32</span>, <span class="ident">f64</span><span class="op">></span>::<span class="ident">from_str</span>(<span class="ident">wast</span>)<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">Command</span> { <span class="ident">kind</span>, .. }) <span class="op">=</span> <span class="ident">parser</span>.<span class="ident">next</span>()<span class="question-mark">?</span> {
|
|||
|
|
<span class="kw">match</span> <span class="ident">kind</span> {
|
|||
|
|
<span class="ident">CommandKind</span>::<span class="ident">Module</span> { <span class="ident">module</span>, <span class="ident">name</span> } <span class="op">=</span><span class="op">></span> {
|
|||
|
|
<span class="comment">// The module is declared as annonymous.</span>
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">name</span>, <span class="prelude-val">None</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Convert the module into the binary representation and check the magic number.</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">module_binary</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">into_vec</span>();
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">module_binary</span>[<span class="number">0</span>..<span class="number">4</span>], <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">97</span>, <span class="number">115</span>, <span class="number">109</span>]);
|
|||
|
|
}
|
|||
|
|
<span class="ident">CommandKind</span>::<span class="ident">AssertReturn</span> { <span class="ident">action</span>, <span class="ident">expected</span> } <span class="op">=</span><span class="op">></span> {
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">action</span>, <span class="ident">Action</span>::<span class="ident">Invoke</span> {
|
|||
|
|
<span class="ident">module</span>: <span class="prelude-val">None</span>,
|
|||
|
|
<span class="ident">field</span>: <span class="string">"sub"</span>.<span class="ident">to_string</span>(),
|
|||
|
|
<span class="ident">args</span>: <span class="macro">vec</span><span class="macro">!</span>[
|
|||
|
|
<span class="ident">Value</span>::<span class="ident">I32</span>(<span class="number">8</span>),
|
|||
|
|
<span class="ident">Value</span>::<span class="ident">I32</span>(<span class="number">3</span>)
|
|||
|
|
],
|
|||
|
|
});
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">expected</span>, <span class="macro">vec</span><span class="macro">!</span>[<span class="ident">Value</span>::<span class="ident">I32</span>(<span class="number">5</span>)]);
|
|||
|
|
},
|
|||
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"there are no other commands apart from that defined above"</span>),
|
|||
|
|
}
|
|||
|
|
}</pre></div>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Command.html" title='wabt::script::Command struct'>Command</a></td><td class='docblock-short'><p>Command in the script.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ModuleBinary.html" title='wabt::script::ModuleBinary struct'>ModuleBinary</a></td><td class='docblock-short'><p>This is a handle to get the binary representation of the module.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ScriptParser.html" title='wabt::script::ScriptParser struct'>ScriptParser</a></td><td class='docblock-short'><p>Parser which allows to parse WebAssembly script text format.</p>
|
|||
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.Action.html" title='wabt::script::Action enum'>Action</a></td><td class='docblock-short'><p>Description of action that should be performed on a wasm module.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CommandKind.html" title='wabt::script::CommandKind enum'>CommandKind</a></td><td class='docblock-short'><p>Script's command.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='wabt::script::Error enum'>Error</a></td><td class='docblock-short'><p>Error that can happen when parsing spec.</p>
|
|||
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Value.html" title='wabt::script::Value enum'>Value</a></td><td class='docblock-short'><p>Wasm value</p>
|
|||
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.FromBits.html" title='wabt::script::FromBits trait'>FromBits</a></td><td class='docblock-short'><p>Bitwise conversion from T</p>
|
|||
|
|
</td></tr></table></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 = "wabt";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|