2019-09-06 15:57:44 -07:00

16 lines
10 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 `values` mod in crate `inkwell`."><meta name="keywords" content="rust, rustlang, rust-lang, values"><title>inkwell::values - 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'>Module values</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>inkwell</a></p><script>window.sidebarCurrent = {name: 'values', ty: 'mod', 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/inkwell/values/mod.rs.html#1-237' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>inkwell</a>::<wbr><a class="mod" href=''>values</a></span></h1><div class='docblock'><p>A value is an instance of a type.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ArrayValue.html" title='inkwell::values::ArrayValue struct'>ArrayValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.BasicValueUse.html" title='inkwell::values::BasicValueUse struct'>BasicValueUse</a></td><td class='docblock-short'><p>A usage of a <code>BasicValue</code> in an <code>InstructionValue</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CallSiteValue.html" title='inkwell::values::CallSiteValue struct'>CallSiteValue</a></td><td class='docblock-short'><p>A value resulting from a function call. It may have function attributes applied to it.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FloatValue.html" title='inkwell::values::FloatValue struct'>FloatValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.FunctionValue.html" title='inkwell::values::FunctionValue struct'>FunctionValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.GenericValue.html" title='inkwell::values::GenericValue struct'>GenericValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.GlobalValue.html" title='inkwell::values::GlobalValue struct'>GlobalValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.InstructionValue.html" title='inkwell::values::InstructionValue struct'>InstructionValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.IntValue.html" title='inkwell::values::IntValue struct'>IntValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.MetadataValue.html" title='inkwell::values::MetadataValue struct'>MetadataValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.PhiValue.html" title='inkwell::values::PhiValue struct'>PhiValue</a></td><td class='docblock-short'><p>A Phi Instruction returns a value based on which basic block branched into
the Phi's containing basic block.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PointerValue.html" title='inkwell::values::PointerValue struct'>PointerValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.StructValue.html" title='inkwell::values::StructValue struct'>StructValue</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.VectorValue.html" title='inkwell::values::VectorValue struct'>VectorValue</a></td><td class='docblock-short'></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.AggregateValueEnum.html" title='inkwell::values::AggregateValueEnum enum'>AggregateValueEnum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.AnyValueEnum.html" title='inkwell::values::AnyValueEnum enum'>AnyValueEnum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.BasicMetadataValueEnum.html" title='inkwell::values::BasicMetadataValueEnum enum'>BasicMetadataValueEnum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.BasicValueEnum.html" title='inkwell::values::BasicValueEnum enum'>BasicValueEnum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.InstructionOpcode.html" title='inkwell::values::InstructionOpcode enum'>InstructionOpcode</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.UnnamedAddress.html" title='inkwell::values::UnnamedAddress enum'>UnnamedAddress</a></td><td class='docblock-short'><p>This enum determines the significance of a <code>GlobalValue</code>'s address.</p>
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.FIRST_CUSTOM_METADATA_KIND_ID.html" title='inkwell::values::FIRST_CUSTOM_METADATA_KIND_ID constant'>FIRST_CUSTOM_METADATA_KIND_ID</a></td><td class='docblock-short'></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.AggregateValue.html" title='inkwell::values::AggregateValue trait'>AggregateValue</a></td><td class='docblock-short'><p>Represents an aggregate value, built on top of other values.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.AnyValue.html" title='inkwell::values::AnyValue trait'>AnyValue</a></td><td class='docblock-short'><p>Defines any struct wrapping an LLVM value.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.BasicValue.html" title='inkwell::values::BasicValue trait'>BasicValue</a></td><td class='docblock-short'><p>Represents a basic value, which can be used both by itself, or in an <code>AggregateValue</code>.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.FloatMathValue.html" title='inkwell::values::FloatMathValue trait'>FloatMathValue</a></td><td class='docblock-short'><p>Represents a value which is permitted in floating point math operations</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.IntMathValue.html" title='inkwell::values::IntMathValue trait'>IntMathValue</a></td><td class='docblock-short'><p>Represents a value which is permitted in integer math operations</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.PointerMathValue.html" title='inkwell::values::PointerMathValue trait'>PointerMathValue</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>