edlang/inkwell/basic_block/struct.BasicBlock.html

346 lines
74 KiB
HTML
Raw Normal View History

<!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="A `BasicBlock` is a container of instructions."><title>BasicBlock in inkwell::basic_block - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="inkwell" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../inkwell/index.html">inkwell</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">BasicBlock</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.delete">delete</a></li><li><a href="#method.get_address">get_address</a></li><li><a href="#method.get_context">get_context</a></li><li><a href="#method.get_first_instruction">get_first_instruction</a></li><li><a href="#method.get_first_use">get_first_use</a></li><li><a href="#method.get_instruction_with_name">get_instruction_with_name</a></li><li><a href="#method.get_instructions">get_instructions</a></li><li><a href="#method.get_last_instruction">get_last_instruction</a></li><li><a href="#method.get_name">get_name</a></li><li><a href="#method.get_next_basic_block">get_next_basic_block</a></li><li><a href="#method.get_parent">get_parent</a></li><li><a href="#method.get_previous_basic_block">get_previous_basic_block</a></li><li><a href="#method.get_terminator">get_terminator</a></li><li><a href="#method.move_after">move_after</a></li><li><a href="#method.move_before">move_before</a></li><li><a href="#method.remove_from_function">remove_from_function</a></li><li><a href="#method.replace_all_uses_with">replace_all_uses_with</a></li><li><a href="#method.set_name">set_name</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-BasicBlock%3C'ctx%3E">Clone</a></li><li><a href="#impl-Copy-for-BasicBlock%3C'ctx%3E">Copy</a></li><li><a href="#impl-Debug-for-BasicBlock%3C'_%3E">Debug</a></li><li><a href="#impl-Eq-for-BasicBlock%3C'ctx%3E">Eq</a></li><li><a href="#impl-Hash-for-BasicBlock%3C'ctx%3E">Hash</a></li><li><a href="#impl-PartialEq-for-BasicBlock%3C'ctx%3E">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-BasicBlock%3C'ctx%3E">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-impleme
<p><code>BasicBlock</code>s are values because they can be referenced by instructions (ie branching and switches).</p>
<p>A well formed <code>BasicBlock</code> is a list of non terminating instructions followed by a single terminating
instruction. <code>BasicBlock</code>s are allowed to be malformed prior to running validation because it may be useful
when constructing or modifying a program.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#33-592">source</a><a href="#impl-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#49-51">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fn">as_mut_ptr</a>(&amp;self) -&gt; <a class="type" href="../../llvm_sys/prelude/type.LLVMBasicBlockRef.html" title="type llvm_sys::prelude::LLVMBasicBlockRef">LLVMBasicBlockRef</a></h4></section></summary><div class="docblock"><p>Acquires the underlying raw pointer belonging to this <code>BasicBlock</code> type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_parent" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#75-77">source</a><h4 class="code-header">pub fn <a href="#method.get_parent" class="fn">get_parent</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Obtains the <code>FunctionValue</code> that this <code>BasicBlock</code> belongs to, if any.</p>
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="macro">assert_eq!</span>(basic_block.get_parent().unwrap(), function);
basic_block.remove_from_function();
<span class="macro">assert!</span>(basic_block.get_parent().is_none());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_previous_basic_block" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#105-109">source</a><h4 class="code-header">pub fn <a href="#method.get_previous_basic_block" class="fn">get_previous_basic_block</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the <code>BasicBlock</code> preceding the current one, in its own scope, if any.</p>
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function1 = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block1 = context.append_basic_block(function1, <span class="string">"entry"</span>);
<span class="macro">assert!</span>(basic_block1.get_previous_basic_block().is_none());
<span class="kw">let </span>function2 = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block2 = context.append_basic_block(function2, <span class="string">"entry"</span>);
<span class="kw">let </span>basic_block3 = context.append_basic_block(function2, <span class="string">"next"</span>);
<span class="macro">assert!</span>(basic_block2.get_previous_basic_block().is_none());
<span class="macro">assert_eq!</span>(basic_block3.get_previous_basic_block().unwrap(), basic_block2);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_next_basic_block" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#138-142">source</a><h4 class="code-header">pub fn <a href="#method.get_next_basic_block" class="fn">get_next_basic_block</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the <code>BasicBlock</code> succeeding the current one, in its own scope, if any.</p>
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function1 = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block1 = context.append_basic_block(function1, <span class="string">"entry"</span>);
<span class="macro">assert!</span>(basic_block1.get_next_basic_block().is_none());
<span class="kw">let </span>function2 = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block2 = context.append_basic_block(function2, <span class="string">"entry"</span>);
<span class="kw">let </span>basic_block3 = context.append_basic_block(function2, <span class="string">"next"</span>);
<span class="macro">assert!</span>(basic_block1.get_next_basic_block().is_none());
<span class="macro">assert_eq!</span>(basic_block2.get_next_basic_block().unwrap(), basic_block3);
<span class="macro">assert!</span>(basic_block3.get_next_basic_block().is_none());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.move_before" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#168-177">source</a><h4 class="code-header">pub fn <a href="#method.move_before" class="fn">move_before</a>(self, basic_block: <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Prepends one <code>BasicBlock</code> before another.
It returns <code>Err(())</code> when either <code>BasicBlock</code> has no parent, as LLVM assumes they both have parents.</p>
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block1 = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="kw">let </span>basic_block2 = context.append_basic_block(function, <span class="string">"next"</span>);
basic_block2.move_before(basic_block1);
<span class="macro">assert!</span>(basic_block1.get_next_basic_block().is_none());
<span class="macro">assert_eq!</span>(basic_block2.get_next_basic_block().unwrap(), basic_block1);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.move_after" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#203-212">source</a><h4 class="code-header">pub fn <a href="#method.move_after" class="fn">move_after</a>(self, basic_block: <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Appends one <code>BasicBlock</code> after another.
It returns <code>Err(())</code> when either <code>BasicBlock</code> has no parent, as LLVM assumes they both have parents.</p>
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block1 = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="kw">let </span>basic_block2 = context.append_basic_block(function, <span class="string">"next"</span>);
basic_block1.move_after(basic_block2);
<span class="macro">assert!</span>(basic_block1.get_next_basic_block().is_none());
<span class="macro">assert_eq!</span>(basic_block2.get_next_basic_block().unwrap(), basic_block1);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_first_instruction" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#236-244">source</a><h4 class="code-header">pub fn <a href="#method.get_first_instruction" class="fn">get_first_instruction</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Obtains the first <code>InstructionValue</code> in this <code>BasicBlock</code>, if any.</p>
<h5 id="example-5"><a class="doc-anchor" href="#example-5">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">use </span>inkwell::values::InstructionOpcode;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
builder.position_at_end(basic_block);
builder.build_return(<span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(basic_block.get_first_instruction().unwrap().get_opcode(), InstructionOpcode::Return);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_last_instruction" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#268-276">source</a><h4 class="code-header">pub fn <a href="#method.get_last_instruction" class="fn">get_last_instruction</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Obtains the last <code>InstructionValue</code> in this <code>BasicBlock</code>, if any. A <code>BasicBlock</code> must have a last instruction to be valid.</p>
<h5 id="example-6"><a class="doc-anchor" href="#example-6">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">use </span>inkwell::values::InstructionOpcode;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
builder.position_at_end(basic_block);
builder.build_return(<span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(basic_block.get_last_instruction().unwrap().get_opcode(), InstructionOpcode::Return);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_instruction_with_name" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#311-314">source</a><h4 class="code-header">pub fn <a href="#method.get_instruction_with_name" class="fn">get_instruction_with_name</a>(
self,
name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Performs a linear lookup to obtain a instruction based on the name</p>
<h5 id="example-7"><a class="doc-anchor" href="#example-7">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::AddressSpace;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"ret"</span>);
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>i32_type = context.i32_type();
<span class="attr">#[cfg(not(any(feature = <span class="string">"llvm15-0"</span>, feature = <span class="string">"llvm16-0"</span>, feature = <span class="string">"llvm17-0"</span>, feature = <span class="string">"llvm18-0"</span>)))]
</span><span class="kw">let </span>i32_ptr_type = i32_type.ptr_type(AddressSpace::default());
<span class="attr">#[cfg(any(feature = <span class="string">"llvm15-0"</span>, feature = <span class="string">"llvm16-0"</span>, feature = <span class="string">"llvm17-0"</span>, feature = <span class="string">"llvm18-0"</span>))]
</span><span class="kw">let </span>i32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[i32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>fn_value = module.add_function(<span class="string">"ret"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>entry = context.append_basic_block(fn_value, <span class="string">"entry"</span>);
builder.position_at_end(entry);
<span class="kw">let </span>var = builder.build_alloca(i32_type, <span class="string">"some_number"</span>).unwrap();
builder.build_store(var, i32_type.const_int(<span class="number">1 </span><span class="kw">as </span>u64, <span class="bool-val">false</span>)).unwrap();
builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="kw">let </span>block = fn_value.get_first_basic_block().unwrap();
<span class="kw">let </span>some_number = block.get_instruction_with_name(<span class="string">"some_number"</span>);
<span class="macro">assert!</span>(some_number.is_some());
<span class="macro">assert_eq!</span>(some_number.unwrap().get_name().unwrap().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"some_number"</span>))</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_terminator" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#342-350">source</a><h4 class="code-header">pub fn <a href="#method.get_terminator" class="fn">get_terminator</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Obtains the terminating <code>InstructionValue</code> in this <code>BasicBlock</code>, if any. A <code>BasicBlock</code> must have a terminating instruction to be valid.</p>
<h5 id="example-8"><a class="doc-anchor" href="#example-8">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">use </span>inkwell::values::InstructionOpcode;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
builder.position_at_end(basic_block);
builder.build_return(<span class="prelude-val">None</span>);
<span class="macro">assert_eq!</span>(basic_block.get_terminator().unwrap().get_opcode(), InstructionOpcode::Return);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_instructions" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#353-355">source</a><h4 class="code-header">pub fn <a href="#method.get_instructions" class="fn">get_instructions</a>(self) -&gt; <a class="struct" href="struct.InstructionIter.html" title="struct inkwell::basic_block::InstructionIter">InstructionIter</a>&lt;'ctx&gt; <a href="#" class="tooltip" data-notable-ty="InstructionIter&lt;&#39;ctx&gt;"></a></h4></section></summary><div class="docblock"><p>Get an instruction iterator</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_from_function" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#383-392">source</a><h4 class="code-header">pub fn <a href="#method.remove_from_function" class="fn">remove_from_function</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Removes this <code>BasicBlock</code> from its parent <code>FunctionValue</code>.
It returns <code>Err(())</code> when it has no parent to remove from.</p>
<h5 id="example-9"><a class="doc-anchor" href="#example-9">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="macro">assert_eq!</span>(basic_block.get_parent().unwrap(), function);
basic_block.remove_from_function();
<span class="macro">assert!</span>(basic_block.get_parent().is_none());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.delete" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#415-424">source</a><h4 class="code-header">pub unsafe fn <a href="#method.delete" class="fn">delete</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Removes this <code>BasicBlock</code> completely from memory. This is unsafe because you could easily have other references to the same <code>BasicBlock</code>.
It returns <code>Err(())</code> when it has no parent to delete from, as LLVM assumes it has a parent.</p>
<h5 id="example-10"><a class="doc-anchor" href="#example-10">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="kw">unsafe </span>{
basic_block.delete();
}
<span class="macro">assert!</span>(function.get_basic_blocks().is_empty());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_context" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#443-445">source</a><h4 class="code-header">pub fn <a href="#method.get_context" class="fn">get_context</a>(self) -&gt; <a class="struct" href="../context/struct.ContextRef.html" title="struct inkwell::context::ContextRef">ContextRef</a>&lt;'ctx&gt;</h4></section></summary><div class="docblock"><p>Obtains the <code>ContextRef</code> this <code>BasicBlock</code> belongs to.</p>
<h5 id="example-11"><a class="doc-anchor" href="#example-11">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::module::Module;
<span class="kw">use </span>inkwell::builder::Builder;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"do_nothing"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>basic_block = context.append_basic_block(function, <span class="string">"entry"</span>);
<span class="macro">assert_eq!</span>(context, basic_block.get_context());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_name" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#464-468">source</a><h4 class="code-header">pub fn <a href="#method.get_name" class="fn">get_name</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ffi/c_str/struct.CStr.html" title="struct core::ffi::c_str::CStr">CStr</a></h4></section></summary><div class="docblock"><p>Gets the name of a <code>BasicBlock</code>.</p>
<h5 id="example-12"><a class="doc-anchor" href="#example-12">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>fn_val = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>bb = context.append_basic_block(fn_val, <span class="string">"entry"</span>);
<span class="macro">assert_eq!</span>(bb.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"entry"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_name" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#471-486">source</a><h4 class="code-header">pub fn <a href="#method.set_name" class="fn">set_name</a>(&amp;self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Set name of the <code>BasicBlock</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.replace_all_uses_with" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#511-521">source</a><h4 class="code-header">pub fn <a href="#method.replace_all_uses_with" class="fn">replace_all_uses_with</a>(self, other: &amp;<a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;)</h4></section></summary><div class="docblock"><p>Replaces all uses of this basic block with another.</p>
<h5 id="example-13"><a class="doc-anchor" href="#example-13">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>fn_val = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>entry = context.append_basic_block(fn_val, <span class="string">"entry"</span>);
<span class="kw">let </span>bb1 = context.append_basic_block(fn_val, <span class="string">"bb1"</span>);
<span class="kw">let </span>bb2 = context.append_basic_block(fn_val, <span class="string">"bb2"</span>);
builder.position_at_end(entry);
<span class="kw">let </span>branch_inst = builder.build_unconditional_branch(bb1).unwrap();
bb1.replace_all_uses_with(<span class="kw-2">&amp;</span>bb2);
<span class="macro">assert_eq!</span>(branch_inst.get_operand(<span class="number">0</span>).unwrap().right().unwrap(), bb2);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_first_use" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#547-555">source</a><h4 class="code-header">pub fn <a href="#method.get_first_use" class="fn">get_first_use</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the first use of this <code>BasicBlock</code> if any.</p>
<p>The following example,</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::AddressSpace;
<span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::values::BasicValue;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"ivs"</span>);
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>fn_val = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>entry = context.append_basic_block(fn_val, <span class="string">"entry"</span>);
<span class="kw">let </span>bb1 = context.append_basic_block(fn_val, <span class="string">"bb1"</span>);
<span class="kw">let </span>bb2 = context.append_basic_block(fn_val, <span class="string">"bb2"</span>);
builder.position_at_end(entry);
<span class="kw">let </span>branch_inst = builder.build_unconditional_branch(bb1);
<span class="macro">assert!</span>(bb2.get_first_use().is_none());
<span class="macro">assert!</span>(bb1.get_first_use().is_some());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_address" class="method"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#578-591">source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_address" class="fn">get_address</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../values/struct.PointerValue.html" title="struct inkwell::values::PointerValue">PointerValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the address of this <code>BasicBlock</code> if possible. Returns <code>None</code> if <code>self</code> is the entry block to a function.</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>The returned PointerValue may only be used for <code>call</code> and <code>indirect_branch</code> instructions</p>
<h5 id="example-14"><a class="doc-anchor" href="#example-14">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>fn_val = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>entry_bb = context.append_basic_block(fn_val, <span class="string">"entry"</span>);
<span class="kw">let </span>next_bb = context.append_basic_block(fn_val, <span class="string">"next"</span>);
<span class="macro">assert!</span>(<span class="kw">unsafe </span>{ entry_bb.get_address() }.is_none());
<span class="macro">assert!</span>(<span class="kw">unsafe </span>{ next_bb.get_address() }.is_some());</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-Clone-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-BasicBlock%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#594-607">source</a><a href="#impl-Debug-for-BasicBlock%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'_&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#595-606">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.80.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Hash-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-Hash-for-Basi
H: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
Self: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.80.0/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-PartialEq-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/cmp.rs.html#263">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason.</div></details></div></details><section id="impl-Copy-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-Copy-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-Eq-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-Eq-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-StructuralPartialEq-for-BasicBlock%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/basic_block.rs.html#27">source</a><a href="#impl-StructuralPartialEq-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-BasicBlock%3C'ctx%3E" class="impl"><a href="#impl-Freeze-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-RefUnwindSafe-for-BasicBlock%3C'ctx%3E" class="impl"><a href="#impl-RefUnwindSafe-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-Send-for-BasicBlock%3C'ctx%3E" class="impl"><a href="#impl-Send-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-Sync-for-BasicBlock%3C'ctx%3E" class="impl"><a href="#impl-Sync-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; !<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;</h3></section><section id="impl-Unpin-for-BasicBlock%3C'ctx%3E" class="impl"><a href="#impl-Unpin-for-BasicBlock%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.BasicBlock.h
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoEither-for-T" class="impl"><a class="src rightside" href="../../src/either/into_either.rs.html#64">source</a><a href="#impl-IntoEither-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../either/into_either/trait.IntoEither.html" title="trait either::into_either::IntoEither">IntoEither</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_either" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#29">source</a><a href="#method.into_either" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either" class="fn">into_either</a>(self, into_left: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;Self, Self&gt;</h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Left</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
if <code>into_left</code> is <code>true</code>.
Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Right</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.into_either_with" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#55-57">source</a><a href="#method.into_either_with" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with" class="fn">into_either_with</a>&lt;F&gt;(self, into_left: F) -&gt; <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;Self, Self&gt;<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Self</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Left</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
if <code>into_left(&amp;self)</code> returns <code>true</code>.
Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Right</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"InstructionIter<'ctx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.InstructionIter.html\" title=\"struct inkwell::basic_block::InstructionIter\">InstructionIter</a>&lt;'ctx&gt;</code></h3><pre><code><div class=\"where\">impl&lt;'ctx&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.InstructionIter.html\" title=\"struct inkwell::basic_block::InstructionIter\">InstructionIter</a>&lt;'ctx&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"struct\" href=\"../values/struct.InstructionValue.html\" title=\"struct inkwell::values::InstructionValue\">InstructionValue</a>&lt;'ctx&gt;;</div>"}</script></section></div></main></body></html>