llvm_kaleidoscope_rs/llvm/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

<!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="Safe wrapper around the LLVM C API."><meta name="keywords" content="rust, rustlang, rust-lang, llvm"><title>llvm_kaleidoscope_rs::llvm - 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="../../light.css"  id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../llvm_kaleidoscope_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module llvm</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="llvm" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input"name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">llvm_kaleidoscope_rs</a>::<wbr><a class="mod" href="#">llvm</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><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/llvm_kaleidoscope_rs/llvm/mod.rs.html#1-78" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Safe wrapper around the LLVM C API.</p>
<p>References returned from the LLVM API are tied to the <code>'llvm</code> lifetime which is bound to the
context where the objects are created in.
We do not offer wrappers to remove or delete any objects in the context and therefore all the
references will be valid for the liftime of the context.</p>
<p>For the scope of this tutorial we mainly use assertions to validate the results from the LLVM
API calls.</p>
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.BasicBlock.html" title="llvm_kaleidoscope_rs::llvm::BasicBlock struct">BasicBlock</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Basic Block.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.FnValue.html" title="llvm_kaleidoscope_rs::llvm::FnValue struct">FnValue</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Value Reference specialized for contexts where function values are needed.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.FunctionPassManager.html" title="llvm_kaleidoscope_rs::llvm::FunctionPassManager struct">FunctionPassManager</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Function PassManager (legacy).</p>
</div><div class="item-left module-item"><a class="struct" href="struct.IRBuilder.html" title="llvm_kaleidoscope_rs::llvm::IRBuilder struct">IRBuilder</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM IR Builder.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.LLJit.html" title="llvm_kaleidoscope_rs::llvm::LLJit struct">LLJit</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.Module.html" title="llvm_kaleidoscope_rs::llvm::Module struct">Module</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Module with its own LLVM Context.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.ResourceTracker.html" title="llvm_kaleidoscope_rs::llvm::ResourceTracker struct">ResourceTracker</a></div><div class="item-right docblock-short"><p>A resource handle to code added to an <a href="struct.LLJit.html" title="LLJit"><code>LLJit</code></a> instance. When a <code>ResourceTracker</code> handle is
dropped, the code corresponding to the handle will be removed from the JIT.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Type.html" title="llvm_kaleidoscope_rs::llvm::Type struct">Type</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Type Reference.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.Value.html" title="llvm_kaleidoscope_rs::llvm::Value struct">Value</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Value Reference.</p>
</div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="fn" href="fn.initialize_native_taget.html" title="llvm_kaleidoscope_rs::llvm::initialize_native_taget fn">initialize_native_taget</a></div><div class="item-right docblock-short"><p>Initialize native target for corresponding to host (useful for jitting).</p>
</div><div class="item-left module-item"><a class="fn" href="fn.shutdown.html" title="llvm_kaleidoscope_rs::llvm::shutdown fn">shutdown</a></div><div class="item-right docblock-short"><p>Deallocate and destroy all “ManagedStatic” variables.</p>
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="llvm_kaleidoscope_rs" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
    <script src="../../main.js"></script>
</body></html>