wasmer/rustdoc/dynasmrt/index.html
2019-09-06 15:57:44 -07:00

19 lines
7.5 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `dynasmrt` crate."><meta name="keywords" content="rust, rustlang, rust-lang, dynasmrt"><title>dynasmrt - 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">&#9776;</div><a href='../dynasmrt/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate dynasmrt</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all dynasmrt's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><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'></p><script>window.sidebarCurrent = {name: 'dynasmrt', ty: 'mod', relpath: '../'};</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#1-262' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>dynasmrt</a></span></h1><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="common/index.html" title='dynasmrt::common mod'>common</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="x64/index.html" title='dynasmrt::x64 mod'>x64</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="x86/index.html" title='dynasmrt::x86 mod'>x86</a></td><td class='docblock-short'></td></tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table><tr class='module-item'><td><a class="macro" href="macro.MutPointer.html" title='dynasmrt::MutPointer macro'>MutPointer</a></td><td class='docblock-short'><p>Preforms the same action as the <code>Pointer!</code> macro, but casts to a *mut pointer.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.Pointer.html" title='dynasmrt::Pointer macro'>Pointer</a></td><td class='docblock-short'><p>This macro takes a *const pointer from the source operand, and then casts it to the desired return type.
this allows it to be used as an easy shorthand for passing pointers as dynasm immediate arguments.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.AssemblyOffset.html" title='dynasmrt::AssemblyOffset struct'>AssemblyOffset</a></td><td class='docblock-short'><p>A struct representing an offset into the assembling buffer of a <code>DynasmLabelApi</code> struct.
The wrapped <code>usize</code> is the offset from the start of the assembling buffer in bytes.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DynamicLabel.html" title='dynasmrt::DynamicLabel struct'>DynamicLabel</a></td><td class='docblock-short'><p>A dynamic label</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ExecutableBuffer.html" title='dynasmrt::ExecutableBuffer struct'>ExecutableBuffer</a></td><td class='docblock-short'><p>A structure holding a buffer of executable memory</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Executor.html" title='dynasmrt::Executor struct'>Executor</a></td><td class='docblock-short'><p>A read-only shared reference to the executable buffer inside an Assembler. By
locking it the internal <code>ExecutableBuffer</code> can be accessed and executed.</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.DynasmError.html" title='dynasmrt::DynasmError enum'>DynasmError</a></td><td class='docblock-short'><p>An error type that is returned from various check and check_exact methods</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.DynasmApi.html" title='dynasmrt::DynasmApi trait'>DynasmApi</a></td><td class='docblock-short'><p>This trait represents the interface that must be implemented to allow
the dynasm preprocessor to assemble into a datastructure.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.DynasmLabelApi.html" title='dynasmrt::DynasmLabelApi trait'>DynasmLabelApi</a></td><td class='docblock-short'><p>This trait extends DynasmApi to not only allow assembling, but also labels and various directives</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>&#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>