wasmer/rustdoc/cranelift_codegen/ir/trait.InstBuilderBase.html
2019-09-06 15:57:44 -07:00

22 lines
13 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 `InstBuilderBase` trait in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, InstBuilderBase"><title>cranelift_codegen::ir::InstBuilderBase - 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 trait"><!--[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='../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait InstBuilderBase</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.build">build</a><a href="#tymethod.data_flow_graph">data_flow_graph</a><a href="#tymethod.data_flow_graph_mut">data_flow_graph_mut</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>cranelift_codegen</a>::<wbr><a href='index.html'>ir</a></p><script>window.sidebarCurrent = {name: 'InstBuilderBase', ty: 'trait', 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/cranelift_codegen/ir/builder.rs.html#20-33' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>cranelift_codegen</a>::<wbr><a href='index.html'>ir</a>::<wbr><a class="trait" href=''>InstBuilderBase</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait InstBuilderBase&lt;'f&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
fn <a href='#tymethod.data_flow_graph' class='fnname'>data_flow_graph</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.data_flow_graph_mut' class='fnname'>data_flow_graph_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.build' class='fnname'>build</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data: <a class="enum" href="../../cranelift_codegen/ir/instructions/enum.InstructionData.html" title="enum cranelift_codegen::ir::instructions::InstructionData">InstructionData</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctrl_typevar: <a class="struct" href="../../cranelift_codegen/ir/types/struct.Type.html" title="struct cranelift_codegen::ir::types::Type">Type</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, &amp;'f mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
}</pre></div><div class='docblock'><p>Base trait for instruction builders.</p>
<p>The <code>InstBuilderBase</code> trait provides the basic functionality required by the methods of the
generated <code>InstBuilder</code> trait. These methods should not normally be used directly. Use the
methods in the <code>InstBuilder</code> trait instead.</p>
<p>Any data type that implements <code>InstBuilderBase</code> also gets all the methods of the <code>InstBuilder</code>
trait.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.data_flow_graph' class='method'><code id='data_flow_graph.v'>fn <a href='#tymethod.data_flow_graph' class='fnname'>data_flow_graph</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code></h3><div class='docblock'><p>Get an immutable reference to the data flow graph that will hold the constructed
instructions.</p>
</div><h3 id='tymethod.data_flow_graph_mut' class='method'><code id='data_flow_graph_mut.v'>fn <a href='#tymethod.data_flow_graph_mut' class='fnname'>data_flow_graph_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code></h3><div class='docblock'><p>Get a mutable reference to the data flow graph that will hold the constructed
instructions.</p>
</div><h3 id='tymethod.build' class='method'><code id='build.v'>fn <a href='#tymethod.build' class='fnname'>build</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;data: <a class="enum" href="../../cranelift_codegen/ir/instructions/enum.InstructionData.html" title="enum cranelift_codegen::ir::instructions::InstructionData">InstructionData</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctrl_typevar: <a class="struct" href="../../cranelift_codegen/ir/types/struct.Type.html" title="struct cranelift_codegen::ir::types::Type">Type</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, &amp;'f mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>Insert an instruction and return a reference to it, consuming the builder.</p>
<p>The result types may depend on a controlling type variable. For non-polymorphic
instructions with multiple results, pass <code>INVALID</code> for the <code>ctrl_typevar</code> argument.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-InstBuilderBase%3C%27f%3E' class='impl'><code class='in-band'>impl&lt;'f, IIB:&nbsp;<a class="trait" href="../../cranelift_codegen/ir/trait.InstInserterBase.html" title="trait cranelift_codegen::ir::InstInserterBase">InstInserterBase</a>&lt;'f&gt;&gt; InstBuilderBase&lt;'f&gt; for <a class="struct" href="../../cranelift_codegen/ir/struct.InsertBuilder.html" title="struct cranelift_codegen::ir::InsertBuilder">InsertBuilder</a>&lt;'f, IIB&gt;</code><a href='#impl-InstBuilderBase%3C%27f%3E' class='anchor'></a><a class='srclink' href='../../src/cranelift_codegen/ir/builder.rs.html#116-134' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.data_flow_graph' class="method hidden"><code id='data_flow_graph.v-1'>fn <a href='#method.data_flow_graph' class='fnname'>data_flow_graph</a>(&amp;self) -&gt; &amp;<a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code><a class='srclink' href='../../src/cranelift_codegen/ir/builder.rs.html#117-119' title='goto source code'>[src]</a></h4><h4 id='method.data_flow_graph_mut' class="method hidden"><code id='data_flow_graph_mut.v-1'>fn <a href='#method.data_flow_graph_mut' class='fnname'>data_flow_graph_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code><a class='srclink' href='../../src/cranelift_codegen/ir/builder.rs.html#121-123' title='goto source code'>[src]</a></h4><h4 id='method.build' class="method hidden"><code id='build.v-1'>fn <a href='#method.build' class='fnname'>build</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;data: <a class="enum" href="../../cranelift_codegen/ir/instructions/enum.InstructionData.html" title="enum cranelift_codegen::ir::instructions::InstructionData">InstructionData</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctrl_typevar: <a class="struct" href="../../cranelift_codegen/ir/types/struct.Type.html" title="struct cranelift_codegen::ir::types::Type">Type</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, &amp;'f mut <a class="struct" href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html" title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/cranelift_codegen/ir/builder.rs.html#125-133' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/cranelift_codegen/ir/trait.InstBuilderBase.js">
</script></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 = "cranelift_codegen";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>