blob: 9e00f325df6d0aa7eb3b65c48435ec8f95ab455f (
plain) (
tree)
|
|
<!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="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../llvm_kaleidoscope_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../llvm_kaleidoscope_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Module llvm</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../llvm_kaleidoscope_rs/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1">
<a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<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 item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/llvm_kaleidoscope_rs/llvm/mod.rs.html#1-74">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><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="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><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><div class="item-row"><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><div class="item-row"><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><div class="item-row"><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><div class="item-row"><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"><p>Wrapper for a LLVM <a href="https://www.llvm.org/docs/ORCv2.html#lljit-and-lllazyjit">LLJIT</a>.</p>
</div></div><div class="item-row"><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><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PhiValue.html" title="llvm_kaleidoscope_rs::llvm::PhiValue struct">PhiValue</a></div><div class="item-right docblock-short"><p>Wrapper for a LLVM Value Reference specialized for contexts where phi values are needed.</p>
</div></div><div class="item-row"><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 for code added to an <a href="struct.LLJit.html" title="LLJit"><code>LLJit</code></a> instance.</p>
</div></div><div class="item-row"><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><div class="item-row"><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></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><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><div class="item-row"><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></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="llvm_kaleidoscope_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0 (4b91a6ea7 2022-08-08)" ></div>
</body></html>
|
