fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-05-17 12:51:19 +00:00
Code Issues Projects Releases Wiki Activity
wasmer/rustdoc/inkwell/index.html
Nick Lewycky 621a665633 Publishing GitHub Pages ***NO_CI***
2019-09-06 15:57:44 -07:00

22 lines
9.7 KiB
HTML
Raw 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 `inkwell` crate."><meta name="keywords" content="rust, rustlang, rust-lang, inkwell"><title>inkwell - 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='../inkwell/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate inkwell</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all inkwell's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'inkwell', 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/inkwell/lib.rs.html#1-321' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>inkwell</a></span></h1><div class='docblock'><p>Inkwell documentation is a work in progress.</p>
<p>If you have any LLVM knowledge that could be used to improve these docs, we would greatly appreciate you opening an issue and/or a pull request on our <a href="https://github.com/TheDan64/inkwell">GitHub page</a>.</p>
<p>Due to a rustdoc issue, this documentation represents only the latest supported LLVM version. We hope that this issue will be resolved in the future so that multiple versions can be documented side by side.</p>
<h1 id="library-wide-notes" class="section-header"><a href="#library-wide-notes">Library Wide Notes</a></h1>
<ul>
<li>Most functions which take a string slice as input may possibly panic in the unlikely event that a c style string cannot be created based on it. (IE if your slice already has a null byte in it)</li>
</ul>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="attributes/index.html" title='inkwell::attributes mod'>attributes</a></td><td class='docblock-short'><p><code>Attribute</code>s are optional modifiers to functions, function parameters, and return types.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="basic_block/index.html" title='inkwell::basic_block mod'>basic_block</a></td><td class='docblock-short'><p>A <code>BasicBlock</code> is a container of instructions.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="builder/index.html" title='inkwell::builder mod'>builder</a></td><td class='docblock-short'><p>A <code>Builder</code> enables you to build instructions.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="comdat/index.html" title='inkwell::comdat mod'>comdat</a></td><td class='docblock-short'><p>A <code>Comdat</code> helps resolve linker errors for duplicate sections.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="context/index.html" title='inkwell::context mod'>context</a></td><td class='docblock-short'><p>A <code>Context</code> is an opaque owner and manager of core global data.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="data_layout/index.html" title='inkwell::data_layout mod'>data_layout</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="execution_engine/index.html" title='inkwell::execution_engine mod'>execution_engine</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="memory_buffer/index.html" title='inkwell::memory_buffer mod'>memory_buffer</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="module/index.html" title='inkwell::module mod'>module</a></td><td class='docblock-short'><p>A <code>Module</code> represets a single code compilation unit.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="object_file/index.html" title='inkwell::object_file mod'>object_file</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="passes/index.html" title='inkwell::passes mod'>passes</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="support/index.html" title='inkwell::support mod'>support</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="targets/index.html" title='inkwell::targets mod'>targets</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="types/index.html" title='inkwell::types mod'>types</a></td><td class='docblock-short'><p>A type is a classification which determines how data is used.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="values/index.html" title='inkwell::values mod'>values</a></td><td class='docblock-short'><p>A value is an instance of a type.</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.AddressSpace.html" title='inkwell::AddressSpace enum'>AddressSpace</a></td><td class='docblock-short'><p>Defines the address space in which a global will be inserted.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.AtomicOrdering.html" title='inkwell::AtomicOrdering enum'>AtomicOrdering</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.AtomicRMWBinOp.html" title='inkwell::AtomicRMWBinOp enum'>AtomicRMWBinOp</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.DLLStorageClass.html" title='inkwell::DLLStorageClass enum'>DLLStorageClass</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.FloatPredicate.html" title='inkwell::FloatPredicate enum'>FloatPredicate</a></td><td class='docblock-short'><p>Defines how to compare a <code>left</code> and <code>right</code> <code>FloatValue</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GlobalVisibility.html" title='inkwell::GlobalVisibility enum'>GlobalVisibility</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.IntPredicate.html" title='inkwell::IntPredicate enum'>IntPredicate</a></td><td class='docblock-short'><p>This enum defines how to compare a <code>left</code> and <code>right</code> <code>IntValue</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.OptimizationLevel.html" title='inkwell::OptimizationLevel enum'>OptimizationLevel</a></td><td class='docblock-short'><p>Defines the optimization level used to compile a <code>Module</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ThreadLocalMode.html" title='inkwell::ThreadLocalMode enum'>ThreadLocalMode</a></td><td class='docblock-short'></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 = "inkwell";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink