wasmer/rustdoc/dynasmrt/trait.DynasmApi.html

32 lines
19 KiB
HTML
Raw Normal View History

2019-09-06 15:57:44 -07:00
<!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 `DynasmApi` trait in crate `dynasmrt`."><meta name="keywords" content="rust, rustlang, rust-lang, DynasmApi"><title>dynasmrt::DynasmApi - 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">&#9776;</div><a href='../dynasmrt/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait DynasmApi</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.offset">offset</a><a href="#tymethod.push">push</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.push_i16">push_i16</a><a href="#method.push_i32">push_i32</a><a href="#method.push_i64">push_i64</a><a href="#method.push_i8">push_i8</a><a href="#method.push_u16">push_u16</a><a href="#method.push_u32">push_u32</a><a href="#method.push_u64">push_u64</a><a href="#method.runtime_error">runtime_error</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-DynasmApi-for-Vec%3Cu8%3E">Vec&lt;u8&gt;</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>dynasmrt</a></p><script>window.sidebarCurrent = {name: 'DynasmApi', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/dynasmrt/lib.rs.html#147-205' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>dynasmrt</a>::<wbr><a class="trait" href=''>DynasmApi</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait DynasmApi: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt; + for&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a>&lt;&amp;'a <a class="primitive" href="https://
fn <a href='#tymethod.offset' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.push' class='fnname'>push</a>(&amp;mut self, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>);
fn <a href='#method.push_i8' class='fnname'>push_i8</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_i16' class='fnname'>push_i16</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_i32' class='fnname'>push_i32</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_i64' class='fnname'>push_i64</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_u16' class='fnname'>push_u16</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_u32' class='fnname'>push_u32</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.push_u64' class='fnname'>push_u64</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) { ... }
<div class='item-spacer'></div> fn <a href='#method.runtime_error' class='fnname'>runtime_error</a>(&amp;self, msg: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a> { ... }
}</pre></div><div class='docblock'><p>This trait represents the interface that must be implemented to allow
the dynasm preprocessor to assemble into a datastructure.</p>
</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.offset' class='method'><code id='offset.v'>fn <a href='#tymethod.offset' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a></code></h3><div class='docblock'><p>Report the current offset into the assembling target</p>
</div><h3 id='tymethod.push' class='method'><code id='push.v'>fn <a href='#tymethod.push' class='fnname'>push</a>(&amp;mut self, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></h3><div class='docblock'><p>Push a byte into the assembling target</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.push_i8' class='method'><code id='push_i8.v'>fn <a href='#method.push_i8' class='fnname'>push_i8</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>)</code></h3><div class='docblock'><p>Push a signed byte into the assembling target</p>
</div><h3 id='method.push_i16' class='method'><code id='push_i16.v'>fn <a href='#method.push_i16' class='fnname'>push_i16</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>)</code></h3><div class='docblock'><p>Push a signed word into the assembling target</p>
</div><h3 id='method.push_i32' class='method'><code id='push_i32.v'>fn <a href='#method.push_i32' class='fnname'>push_i32</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></h3><div class='docblock'><p>Push a signed doubleword into the assembling target</p>
</div><h3 id='method.push_i64' class='method'><code id='push_i64.v'>fn <a href='#method.push_i64' class='fnname'>push_i64</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>)</code></h3><div class='docblock'><p>Push a signed quadword into the assembling target</p>
</div><h3 id='method.push_u16' class='method'><code id='push_u16.v'>fn <a href='#method.push_u16' class='fnname'>push_u16</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</code></h3><div class='docblock'><p>Push an usigned word into the assembling target</p>
</div><h3 id='method.push_u32' class='method'><code id='push_u32.v'>fn <a href='#method.push_u32' class='fnname'>push_u32</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>Push an usigned doubleword into the assembling target</p>
</div><h3 id='method.push_u64' class='method'><code id='push_u64.v'>fn <a href='#method.push_u64' class='fnname'>push_u64</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></h3><div class='docblock'><p>Push an usigned quadword into the assembling target</p>
</div><h3 id='method.runtime_error' class='method'><code id='runtime_error.v'>fn <a href='#method.runtime_error' class='fnname'>runtime_error</a>(&amp;self, msg: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a></code></h3><div class='docblock'><p>This function is called in when a runtime error has to be generated. It panics.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-DynasmApi-for-Vec%3Cu8%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../dynasmrt/trait.DynasmApi.html" title="trait dynasmrt::DynasmApi">DynasmApi</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</code><a href='#impl-DynasmApi-for-Vec%3Cu8%3E' class='anchor'></a><a class='srclink' href='../src/dynasmrt/lib.rs.html#233-241' title='goto source code'>[src]</a></h3><div class='docblock'><p>A basic implementation of DynasmApi onto a simple Vec<u8> to assist debugging</p>
</div><div class='impl-items'><h4 id='method.offset' class="method hidden"><code id='offset.v-1'>fn <a href='#method.offset' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a></code><a class='srclink' href='../src/dynasmrt/lib.rs.html#234-236' title='goto source code'>[src]</a></h4><h4 id='method.push' class="method hidden"><code id='push.v-1'>fn <a href='#method.push' class='fnname'>push</a>(&amp;mut self, byte: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code><a class='srclink' href='../src/dynasmrt/lib.rs.html#238-240' title='goto source code'>[src]</a></h4></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-DynasmApi' class='impl'><code class='in-band'>impl DynasmApi for dynasmrt::x64::<a class="struct" href="../dynasmrt/x64/struct.Assembler.html" title="struct dynasmrt::x64::Assembler">Assembler</a></code><a href='#impl-DynasmApi' class='anchor'></a><a class='srclink' href='../src/dynasmrt/x64.rs.html#235-245' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset-1' class="method hidden"><code id='offset.v-2'>fn <a href='#method.offset-1' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a></code><a class='srclink' href='../src/dynasmrt/x64.rs.html#237-239' title='goto source code'>[src]</a></h4><h4 id='method.push-1' class="method hidden"><code id='push.v-2'>fn <a href='#method.push-1' class='fnname'>push</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code><a class='srclink' href='../src/dynasmrt/x64.rs.html#242-244' title='goto source code'>[src]</a></h4></div><h3 id='impl-DynasmApi-1' class='impl'><code class='in-band'>impl DynasmApi for dynasmrt::x86::<a class="struct" href="../dynasmrt/x86/struct.Assembler.html" title="struct dynasmrt::x86::Assembler">Assembler</a></code><a href='#impl-DynasmApi-1' class='anchor'></a><a class='srclink' href='../src/dynasmrt/x86.rs.html#309-319' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset-2' class="method hidden"><code id='offset.v-3'>fn <a href='#method.offset-2' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a></code><a class='srclink' href='../src/dynasmrt/x86.rs.html#311-313' title='goto source code'>[src]</a></h4><h4 id='method.push-2' class="method hidden"><code id='push.v-3'>fn <a href='#method.push-2' class='fnname'>push</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code><a class='srclink' href='../src/dynasmrt/x86.rs.html#316-318' title='goto source code'>[src]</a></h4></div><h3 id='impl-DynasmApi-2' class='impl'><code class='in-band'>impl&lt;'a&gt; DynasmApi for <a class="struct" href="../dynasmrt/common/struct.UncommittedModifier.html" title="struct dynasmrt::common::UncommittedModifier">UncommittedModifier</a>&lt;'a&gt;</code><a href='#impl-DynasmApi-2' class='anchor'></a><a class='srclink' href='../src/dynasmrt/common.rs.html#202-213' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset-3' class="method hidden"><code id='offset.v-4'>fn <a href='#method.offset-3' class='fnname'>offset</a>(&amp;self) -&gt; <a class="struct" href="../dynasmrt/struct.AssemblyOffset.html" title="struct dynasmrt::AssemblyOffset">AssemblyOffset</a></code><a class='srclink' href='../src/dynasmrt/common.rs.html#204-206' title='goto source code'>[src]</a></h4><h4 id='method.push-3' class="method hidden"><code id='push.v-4'>fn <a href='#method.push-3' class='fnname'>push</a>(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code><a class='srclink' href='../src/dynasmrt/common.rs.html#209-212' title='goto source code'>[src]</a></h4></div><h3 id='impl-DynasmApi-3' class='impl'><code class='in-band'>impl&lt;'a, 'b&gt; DynasmApi for dynasmrt::x64::<a class="struct" href="../dynasmrt/x64/struct.AssemblyModifier.html" title="struct dynasmrt::x64::AssemblyModifier">AssemblyModifier</a>&lt;'a, 'b&gt;</code><a href='#impl-DynasmApi-3' class='anchor'></a><a class='srclink' href='../src/dynasmrt/x64.rs.html#418-429' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset-4' class="method hidden"><code id='offset.v-5'>fn <a href='#method.offset-4' class='fnname'>offset</a
src="../implementors/dynasmrt/trait.DynasmApi.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>&#9166;</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 = "dynasmrt";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>