<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `InsertBuilder` struct in crate `cranelift_codegen`."><metaname="keywords"content="rust, rustlang, rust-lang, InsertBuilder"><title>cranelift_codegen::ir::InsertBuilder - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="shortcut icon"href="../../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../cranelift_codegen/index.html'><divclass='logo-container'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct InsertBuilder</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.new">new</a><ahref="#method.with_result">with_result</a><ahref="#method.with_results">with_results</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-InstBuilderBase%3C%27f%3E">InstBuilderBase<'f></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><pclass='location'><ahref='../index.html'>cranelift_codegen</a>::<wbr><ahref='index.html'>ir</a></p><script>window.sidebarCurrent={name:'InsertBuilder',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#69-72'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='../index.html'>cranelift_codegen</a>::<wbr><ahref='index.html'>ir</a>::<wbr><aclass="struct"href=''>InsertBuilder</a></span></h1><divclass="docblock type-decl hidden-by-usual-hider"><preclass='ruststruct
<p>An <code>InsertBuilder</code> is a wrapper for an <code>InstInserterBase</code> that turns it into an instruction
builder with some additional facilities for creating instructions that reuse existing values as
their results.</p>
</div><h2id='methods'class='small-section-header'>Methods<ahref='#methods'class='anchor'></a></h2><h3id='impl'class='impl'><codeclass='in-band'>impl<'f, IIB: <aclass="trait"href="../../cranelift_codegen/ir/trait.InstInserterBase.html"title="trait cranelift_codegen::ir::InstInserterBase">InstInserterBase</a><'f>><aclass="struct"href="../../cranelift_codegen/ir/struct.InsertBuilder.html"title="struct cranelift_codegen::ir::InsertBuilder">InsertBuilder</a><'f, IIB></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#74-114'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.new'class="method"><codeid='new.v'>pub fn <ahref='#method.new'class='fnname'>new</a>(inserter: IIB) -> Self</code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#77-82'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Create a new builder which inserts instructions at <code>pos</code>.
The <code>dfg</code> and <code>pos.layout</code> references should be from the same <code>Function</code>.</p>
</div><h4id='method.with_results'class="method"><codeid='with_results.v'>pub fn <ahref='#method.with_results'class='fnname'>with_results</a><Array>(<br> self, <br> reuse: Array<br>) -> InsertReuseBuilder<'f, IIB, Array><spanclass="where fmt-newline">where<br> Array: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Value.html"title="struct cranelift_codegen::ir::entities::Value">Value</a>><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#91-100'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Reuse result values in <code>reuse</code>.</p>
<p>Convert this builder into one that will reuse the provided result values instead of
allocating new ones. The provided values for reuse must not be attached to anything. Any
missing result values will be allocated as normal.</p>
<p>The <code>reuse</code> argument is expected to be an array of <code>Option<Value></code>.</p>
</div><h4id='method.with_result'class="method"><codeid='with_result.v'>pub fn <ahref='#method.with_result'class='fnname'>with_result</a>(<br> self, <br> v: <aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Value.html"title="struct cranelift_codegen::ir::entities::Value">Value</a><br>) -> InsertReuseBuilder<'f, IIB, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Value.html"title="struct cranelift_codegen::ir::entities::Value">Value</a>><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 1]</a>></code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#109-113'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Reuse a single result value.</p>
<p>Convert this into a builder that will reuse <code>v</code> as the single result value. The reused
result value <code>v</code> must not be attached to anything.</p>
<p>This method should only be used when building an instruction with exactly one result. Use
<code>with_results()</code> for the more general case.</p>
</div></div><h2id='implementations'class='small-section-header'>Trait Implementations<ahref='#implementations'class='anchor'></a></h2><divid='implementations-list'><h3id='impl-InstBuilderBase%3C%27f%3E'class='impl'><codeclass='in-band'>impl<'f, IIB: <aclass="trait"href="../../cranelift_codegen/ir/trait.InstInserterBase.html"title="trait cranelift_codegen::ir::InstInserterBase">InstInserterBase</a><'f>><aclass="trait"href="../../cranelift_codegen/ir/trait.InstBuilderBase.html"title="trait cranelift_codegen::ir::InstBuilderBase">InstBuilderBase</a><'f> for <aclass="struct"href="../../cranelift_codegen/ir/struct.InsertBuilder.html"title="struct cranelift_codegen::ir::InsertBuilder">InsertBuilder</a><'f, IIB></code><ahref='#impl-InstBuilderBase%3C%27f%3E'class='anchor'></a><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#116-134'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.data_flow_graph'class="method hidden"><codeid='data_flow_graph.v'>fn <ahref='../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.data_flow_graph'class='fnname'>data_flow_graph</a>(&self) ->&<aclass="struct"href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html"title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#117-119'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Get an immutable reference to the data flow graph that will hold the constructed instructions. <ahref="../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.data_flow_graph">Read more</a></p>
</div><h4id='method.data_flow_graph_mut'class="method hidden"><codeid='data_flow_graph_mut.v'>fn <ahref='../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.data_flow_graph_mut'class='fnname'>data_flow_graph_mut</a>(&mut self) ->&mut <aclass="struct"href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html"title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a></code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#121-123'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Get a mutable reference to the data flow graph that will hold the constructed instructions. <ahref="../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.data_flow_graph_mut">Read more</a></p>
</div><h4id='method.build'class="method hidden"><codeid='build.v'>fn <ahref='../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.build'class='fnname'>build</a>(<br> self, <br> data: <aclass="enum"href="../../cranelift_codegen/ir/instructions/enum.InstructionData.html"title="enum cranelift_codegen::ir::instructions::InstructionData">InstructionData</a>, <br> ctrl_typevar: <aclass="struct"href="../../cranelift_codegen/ir/types/struct.Type.html"title="struct cranelift_codegen::ir::types::Type">Type</a><br>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><aclass="struct"href="../../cranelift_codegen/ir/entities/struct.Inst.html"title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, &'f mut <aclass="struct"href="../../cranelift_codegen/ir/dfg/struct.DataFlowGraph.html"title="struct cranelift_codegen::ir::dfg::DataFlowGraph">DataFlowGraph</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><aclass='srclink'href='../../src/cranelift_codegen/ir/builder.rs.html#125-133'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Insert an instruction and return a reference to it, consuming the builder. <ahref="../../cranelift_codegen/ir/trait.InstBuilderBase.html#tymethod.build">Read more</a></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-Into%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></code><ahref='#impl-Into%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.into'class="method hidden"><codeid='into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into'class='fnname'>into</a>(self) -> U</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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>⏎</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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
