edlang/inkwell/values/struct.InstructionValue.html

308 lines
113 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="API documentation for the Rust `InstructionValue` struct in crate `inkwell`."><title>InstructionValue in inkwell::values - 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="#">InstructionValue</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.can_use_fast_math_flags">can_use_fast_math_flags</a></li><li><a href="#method.erase_from_basic_block">erase_from_basic_block</a></li><li><a href="#method.explicit_clone">explicit_clone</a></li><li><a href="#method.get_alignment">get_alignment</a></li><li><a href="#method.get_allocated_type">get_allocated_type</a></li><li><a href="#method.get_atomic_ordering">get_atomic_ordering</a></li><li><a href="#method.get_disjoint_flag">get_disjoint_flag</a></li><li><a href="#method.get_fast_math_flags">get_fast_math_flags</a></li><li><a href="#method.get_fcmp_predicate">get_fcmp_predicate</a></li><li><a href="#method.get_first_use">get_first_use</a></li><li><a href="#method.get_icmp_predicate">get_icmp_predicate</a></li><li><a href="#method.get_instruction_with_name">get_instruction_with_name</a></li><li><a href="#method.get_metadata">get_metadata</a></li><li><a href="#method.get_name">get_name</a></li><li><a href="#method.get_next_instruction">get_next_instruction</a></li><li><a href="#method.get_non_negative_flag">get_non_negative_flag</a></li><li><a href="#method.get_num_operands">get_num_operands</a></li><li><a href="#method.get_opcode">get_opcode</a></li><li><a href="#method.get_operand">get_operand</a></li><li><a href="#method.get_operand_unchecked">get_operand_unchecked</a></li><li><a href="#method.get_operand_use">get_operand_use</a></li><li><a href="#method.get_operand_use_unchecked">get_operand_use_unchecked</a></li><li><a href="#method.get_operand_uses">get_operand_uses</a></li><li><a href="#method.get_operands">get_operands</a></li><li><a href="#method.get_parent">get_parent</a></li><li><a href="#method.get_previous_instruction">get_previous_instruction</a></li><li><a href="#method.get_tail_call_kind">ge
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>The ref must be valid and of type instruction.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.explicit_clone" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#152-154">source</a><h4 class="code-header">pub fn <a href="#method.explicit_clone" class="fn">explicit_clone</a>(&amp;self) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates a clone of this <code>InstructionValue</code>, and returns it.
The clone will have no parent, and no name.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_name" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#157-163">source</a><h4 class="code-header">pub fn <a href="#method.get_name" class="fn">get_name</a>(&amp;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;&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>&gt;</h4></section></summary><div class="docblock"><p>Get name of the <code>InstructionValue</code>.</p>
</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/values/instruction_value.rs.html#167-174">source</a><h4 class="code-header">pub fn <a href="#method.get_instruction_with_name" class="fn">get_instruction_with_name</a>(
&amp;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="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Get a instruction with its name
Compares against all instructions after self, and self.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_name" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#177-184">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>) -&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>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Set name of the <code>InstructionValue</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_type" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#187-189">source</a><h4 class="code-header">pub fn <a href="#method.get_type" class="fn">get_type</a>(self) -&gt; <a class="enum" href="../types/enum.AnyTypeEnum.html" title="enum inkwell::types::AnyTypeEnum">AnyTypeEnum</a>&lt;'ctx&gt;</h4></section></summary><div class="docblock"><p>Get type of the current InstructionValue</p>
</div></details><section id="method.get_opcode" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#191-195">source</a><h4 class="code-header">pub fn <a href="#method.get_opcode" class="fn">get_opcode</a>(self) -&gt; <a class="enum" href="enum.InstructionOpcode.html" title="enum inkwell::values::InstructionOpcode">InstructionOpcode</a></h4></section><section id="method.get_previous_instruction" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#197-205">source</a><h4 class="code-header">pub fn <a href="#method.get_previous_instruction" class="fn">get_previous_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;Self&gt;</h4></section><section id="method.get_next_instruction" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#207-215">source</a><h4 class="code-header">pub fn <a href="#method.get_next_instruction" class="fn">get_next_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;Self&gt;</h4></section><section id="method.erase_from_basic_block" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#218-220">source</a><h4 class="code-header">pub fn <a href="#method.erase_from_basic_block" class="fn">erase_from_basic_block</a>(self)</h4></section><section id="method.remove_from_basic_block" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#223-225">source</a><h4 class="code-header">pub fn <a href="#method.remove_from_basic_block" class="fn">remove_from_basic_block</a>(self)</h4></section><section id="method.get_parent" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#232-234">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="../basic_block/struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;&gt;</h4></section><details class="toggle method-toggle" open><summary><section id="method.is_terminator" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#237-239">source</a><h4 class="code-header">pub fn <a href="#method.is_terminator" class="fn">is_terminator</a>(self) -&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"><p>Returns if the instruction is a terminator</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_conditional" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#243-249">source</a><h4 class="code-header">pub fn <a href="#method.is_conditional" class="fn">is_conditional</a>(self) -&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"><p>Returns if a terminator is conditional or not</p>
</div></details><section id="method.is_tail_call" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#251-258">source</a><h4 class="code-header">pub fn <a href="#method.is_tail_call" class="fn">is_tail_call</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.get_tail_call_kind" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#264-270">source</a><h4 class="code-header">pub fn <a href="#method.get_tail_call_kind" class="fn">get_tail_call_kind</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="enum" href="enum.LLVMTailCallKind.html" title="enum inkwell::values::LLVMTailCallKind">LLVMTailCallKind</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the tail call kind on call instructions.</p>
<p>Other instructions return <code>None</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.can_use_fast_math_flags" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#276-278">source</a><h4 class="code-header">pub fn <a href="#method.can_use_fast_math_flags" class="fn">can_use_fast_math_flags</a>(self) -&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"><p>Check whether this instructions supports <a href="https://llvm.org/docs/LangRef.html#fast-math-flags">fast math flags</a>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_fast_math_flags" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#286-289">source</a><h4 class="code-header">pub fn <a href="#method.get_fast_math_flags" class="fn">get_fast_math_flags</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="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>&gt;</h4></section></summary><div class="docblock"><p>Get <a href="https://llvm.org/docs/LangRef.html#fast-math-flags">fast math flags</a> of supported instructions.</p>
<p>Calling this on unsupported instructions is safe and returns <code>None</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_fast_math_flags" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#297-301">source</a><h4 class="code-header">pub fn <a href="#method.set_fast_math_flags" class="fn">set_fast_math_flags</a>(self, flags: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>)</h4></section></summary><div class="docblock"><p>Set <a href="https://llvm.org/docs/LangRef.html#fast-math-flags">fast math flags</a> on supported instructions.</p>
<p>Calling this on unsupported instructions is safe and results in a no-op.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_non_negative_flag" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#307-310">source</a><h4 class="code-header">pub fn <a href="#method.get_non_negative_flag" class="fn">get_non_negative_flag</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="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>&gt;</h4></section></summary><div class="docblock"><p>Check if a <code>zext</code> instruction has the non-negative flag set.</p>
<p>Calling this function on other instructions is safe and returns <code>None</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_non_negative_flag" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#316-320">source</a><h4 class="code-header">pub fn <a href="#method.set_non_negative_flag" class="fn">set_non_negative_flag</a>(self, flag: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Set the non-negative flag on <code>zext</code> instructions.</p>
<p>Calling this function on other instructions is safe and results in a no-op.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_disjoint_flag" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#326-329">source</a><h4 class="code-header">pub fn <a href="#method.get_disjoint_flag" class="fn">get_disjoint_flag</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="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>&gt;</h4></section></summary><div class="docblock"><p>Checks if an <code>or</code> instruction has the <code>disjoint</code> flag set.</p>
<p>Calling this function on other instructions is safe and returns <code>None</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_disjoint_flag" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#335-339">source</a><h4 class="code-header">pub fn <a href="#method.set_disjoint_flag" class="fn">set_disjoint_flag</a>(self, flag: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Set the <code>disjoint</code> flag on <code>or</code> instructions.</p>
<p>Calling this function on other instructions is safe and results in a no-op.</p>
</div></details><section id="method.replace_all_uses_with" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#341-343">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.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;)</h4></section><details class="toggle method-toggle" open><summary><section id="method.get_volatile" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#360-366">source</a><h4 class="code-header">pub fn <a href="#method.get_volatile" class="fn">get_volatile</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.bool.html">bool</a>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Returns whether or not a memory access instruction is volatile.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_volatile" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#383-390">source</a><h4 class="code-header">pub fn <a href="#method.set_volatile" class="fn">set_volatile</a>(self, volatile: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&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>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Sets whether or not a memory access instruction is volatile.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_allocated_type" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#394-399">source</a><h4 class="code-header">pub fn <a href="#method.get_allocated_type" class="fn">get_allocated_type</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="enum" href="../types/enum.BasicTypeEnum.html" title="enum inkwell::types::BasicTypeEnum">BasicTypeEnum</a>&lt;'ctx&gt;, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the type that is allocated by the alloca instruction.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_alignment" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#403-408">source</a><h4 class="code-header">pub fn <a href="#method.get_alignment" class="fn">get_alignment</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.u32.html">u32</a>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Returns alignment on a memory access instruction or alloca.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_alignment" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#412-428">source</a><h4 class="code-header">pub fn <a href="#method.set_alignment" class="fn">set_alignment</a>(self, alignment: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>) -&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>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Sets alignment on a memory access instruction or alloca.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_atomic_ordering" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#432-437">source</a><h4 class="code-header">pub fn <a href="#method.get_atomic_ordering" class="fn">get_atomic_ordering</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="enum" href="../enum.AtomicOrdering.html" title="enum inkwell::AtomicOrdering">AtomicOrdering</a>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Returns atomic ordering on a memory access instruction.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_atomic_ordering" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#441-462">source</a><h4 class="code-header">pub fn <a href="#method.set_atomic_ordering" class="fn">set_atomic_ordering</a>(
self,
ordering: <a class="enum" href="../enum.AtomicOrdering.html" title="enum inkwell::AtomicOrdering">AtomicOrdering</a>,
) -&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>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Sets atomic ordering on a memory access instruction.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_num_operands" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#523-525">source</a><h4 class="code-header">pub fn <a href="#method.get_num_operands" class="fn">get_num_operands</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Obtains the number of operands an <code>InstructionValue</code> has.
An operand is a <code>BasicValue</code> used in an IR instruction.</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">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>f32_type = context.f32_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>f32_ptr_type = f32_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>f32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[f32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"take_f32_ptr"</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);
<span class="kw">let </span>arg1 = function.get_first_param().unwrap().into_pointer_value();
<span class="kw">let </span>f32_val = f32_type.const_float(std::f64::consts::PI);
<span class="kw">let </span>store_instruction = builder.build_store(arg1, f32_val).unwrap();
<span class="kw">let </span>free_instruction = builder.build_free(arg1).unwrap();
<span class="kw">let </span>return_instruction = builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="macro">assert_eq!</span>(store_instruction.get_num_operands(), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(free_instruction.get_num_operands(), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(return_instruction.get_num_operands(), <span class="number">0</span>);</code></pre></div>
<p>will generate LLVM IR roughly like (varying slightly across LLVM versions):</p>
<div class="example-wrap"><pre class="language-ir"><code>; ModuleID = &#39;ivs&#39;
source_filename = &quot;ivs&quot;
define void @take_f32_ptr(float* %0) {
entry:
store float 0x400921FB60000000, float* %0
%1 = bitcast float* %0 to i8*
tail call void @free(i8* %1)
ret void
}
declare void @free(i8*)
</code></pre></div>
<p>which makes the number of instruction operands clear:</p>
<ol>
<li>Store has two: a const float and a variable float pointer %0</li>
<li>Bitcast has one: a variable float pointer %0</li>
<li>Function call has two: i8 pointer %1 argument, and the free function itself</li>
<li>Void return has zero: void is not a value and does not count as an operand
even though the return instruction can take values.</li>
</ol>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operand" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#591-599">source</a><h4 class="code-header">pub fn <a href="#method.get_operand" class="fn">get_operand</a>(
self,
index: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</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="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;<a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a>&lt;'ctx&gt;, <a class="struct" href="../basic_block/struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;&gt;&gt;</h4></section></summary><div class="docblock"><p>Obtains the operand an <code>InstructionValue</code> has at a given index if any.
An operand is a <code>BasicValue</code> used in an IR instruction.</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">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>f32_type = context.f32_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>f32_ptr_type = f32_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>f32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[f32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"take_f32_ptr"</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);
<span class="kw">let </span>arg1 = function.get_first_param().unwrap().into_pointer_value();
<span class="kw">let </span>f32_val = f32_type.const_float(std::f64::consts::PI);
<span class="kw">let </span>store_instruction = builder.build_store(arg1, f32_val).unwrap();
<span class="kw">let </span>free_instruction = builder.build_free(arg1).unwrap();
<span class="kw">let </span>return_instruction = builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="macro">assert!</span>(store_instruction.get_operand(<span class="number">0</span>).is_some());
<span class="macro">assert!</span>(store_instruction.get_operand(<span class="number">1</span>).is_some());
<span class="macro">assert!</span>(store_instruction.get_operand(<span class="number">2</span>).is_none());
<span class="macro">assert!</span>(free_instruction.get_operand(<span class="number">0</span>).is_some());
<span class="macro">assert!</span>(free_instruction.get_operand(<span class="number">1</span>).is_some());
<span class="macro">assert!</span>(free_instruction.get_operand(<span class="number">2</span>).is_none());
<span class="macro">assert!</span>(return_instruction.get_operand(<span class="number">0</span>).is_none());
<span class="macro">assert!</span>(return_instruction.get_operand(<span class="number">1</span>).is_none());</code></pre></div>
<p>will generate LLVM IR roughly like (varying slightly across LLVM versions):</p>
<div class="example-wrap"><pre class="language-ir"><code>; ModuleID = &#39;ivs&#39;
source_filename = &quot;ivs&quot;
define void @take_f32_ptr(float* %0) {
entry:
store float 0x400921FB60000000, float* %0
%1 = bitcast float* %0 to i8*
tail call void @free(i8* %1)
ret void
}
declare void @free(i8*)
</code></pre></div>
<p>which makes the instruction operands clear:</p>
<ol>
<li>Store has two: a const float and a variable float pointer %0</li>
<li>Bitcast has one: a variable float pointer %0</li>
<li>Function call has two: i8 pointer %1 argument, and the free function itself</li>
<li>Void return has zero: void is not a value and does not count as an operand
even though the return instruction can take values.</li>
</ol>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operand_unchecked" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#606-622">source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_operand_unchecked" class="fn">get_operand_unchecked</a>(
self,
index: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</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="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;<a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a>&lt;'ctx&gt;, <a class="struct" href="../basic_block/struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a>&lt;'ctx&gt;&gt;&gt;</h4></section></summary><div class="docblock"><p>Get the operand of an <code>InstructionValue</code>.</p>
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
<p>The index must be less than <a href="struct.InstructionValue.html#method.get_num_operands" title="method inkwell::values::InstructionValue::get_num_operands">InstructionValue::get_num_operands</a>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operands" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#625-631">source</a><h4 class="code-header">pub fn <a href="#method.get_operands" class="fn">get_operands</a>(self) -&gt; <a class="struct" href="struct.OperandIter.html" title="struct inkwell::values::OperandIter">OperandIter</a>&lt;'ctx&gt; <a href="#" class="tooltip" data-notable-ty="OperandIter&lt;&#39;ctx&gt;"></a></h4></section></summary><div class="docblock"><p>Get an instruction value operand iterator.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_operand" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#667-677">source</a><h4 class="code-header">pub fn <a href="#method.set_operand" class="fn">set_operand</a>&lt;BV: <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt;&gt;(self, index: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>, val: BV) -&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"><p>Sets the operand an <code>InstructionValue</code> has at a given index if possible.
An operand is a <code>BasicValue</code> used in an IR instruction.</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">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>f32_type = context.f32_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>f32_ptr_type = f32_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>f32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[f32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"take_f32_ptr"</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);
<span class="kw">let </span>arg1 = function.get_first_param().unwrap().into_pointer_value();
<span class="kw">let </span>f32_val = f32_type.const_float(std::f64::consts::PI);
<span class="kw">let </span>store_instruction = builder.build_store(arg1, f32_val).unwrap();
<span class="kw">let </span>free_instruction = builder.build_free(arg1).unwrap();
<span class="kw">let </span>return_instruction = builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="comment">// This will produce invalid IR:
</span>free_instruction.set_operand(<span class="number">0</span>, f32_val);
<span class="macro">assert_eq!</span>(free_instruction.get_operand(<span class="number">0</span>).unwrap().left().unwrap(), f32_val);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operand_use" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#710-718">source</a><h4 class="code-header">pub fn <a href="#method.get_operand_use" class="fn">get_operand_use</a>(self, index: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</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="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the use of an operand(<code>BasicValue</code>), if any.</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>f32_type = context.f32_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>f32_ptr_type = f32_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>f32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[f32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"take_f32_ptr"</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);
<span class="kw">let </span>arg1 = function.get_first_param().unwrap().into_pointer_value();
<span class="kw">let </span>f32_val = f32_type.const_float(std::f64::consts::PI);
<span class="kw">let </span>store_instruction = builder.build_store(arg1, f32_val).unwrap();
<span class="kw">let </span>free_instruction = builder.build_free(arg1).unwrap();
<span class="kw">let </span>return_instruction = builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="macro">assert_eq!</span>(store_instruction.get_operand_use(<span class="number">1</span>), arg1.get_first_use());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operand_use_unchecked" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#725-733">source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_operand_use_unchecked" class="fn">get_operand_use_unchecked</a>(
self,
index: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</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="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the use of an operand(<code>BasicValue</code>), if any.</p>
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
<p>The index must be smaller than <a href="struct.InstructionValue.html#method.get_num_operands" title="method inkwell::values::InstructionValue::get_num_operands">InstructionValue::get_num_operands</a>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_operand_uses" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#736-742">source</a><h4 class="code-header">pub fn <a href="#method.get_operand_uses" class="fn">get_operand_uses</a>(self) -&gt; <a class="struct" href="struct.OperandUseIter.html" title="struct inkwell::values::OperandUseIter">OperandUseIter</a>&lt;'ctx&gt; <a href="#" class="tooltip" data-notable-ty="OperandUseIter&lt;&#39;ctx&gt;"></a></h4></section></summary><div class="docblock"><p>Get an instruction value operand use iterator.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_first_use" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#777-779">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="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 an <code>InstructionValue</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>f32_type = context.f32_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>f32_ptr_type = f32_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>f32_ptr_type = context.ptr_type(AddressSpace::default());
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[f32_ptr_type.into()], <span class="bool-val">false</span>);
<span class="kw">let </span>function = module.add_function(<span class="string">"take_f32_ptr"</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);
<span class="kw">let </span>arg1 = function.get_first_param().unwrap().into_pointer_value();
<span class="kw">let </span>f32_val = f32_type.const_float(std::f64::consts::PI);
<span class="kw">let </span>store_instruction = builder.build_store(arg1, f32_val).unwrap();
<span class="kw">let </span>free_instruction = builder.build_free(arg1).unwrap();
<span class="kw">let </span>return_instruction = builder.build_return(<span class="prelude-val">None</span>).unwrap();
<span class="macro">assert!</span>(arg1.get_first_use().is_some());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_icmp_predicate" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#787-797">source</a><h4 class="code-header">pub fn <a href="#method.get_icmp_predicate" class="fn">get_icmp_predicate</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="enum" href="../enum.IntPredicate.html" title="enum inkwell::IntPredicate">IntPredicate</a>&gt;</h4></section></summary><div class="docblock"><p>Gets the predicate of an <code>ICmp</code> <code>InstructionValue</code>.
For instance, in the LLVM instruction
<code>%3 = icmp slt i32 %0, %1</code>
this gives the <code>slt</code>.</p>
<p>If the instruction is not an <code>ICmp</code>, this returns None.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_fcmp_predicate" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#805-815">source</a><h4 class="code-header">pub fn <a href="#method.get_fcmp_predicate" class="fn">get_fcmp_predicate</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="enum" href="../enum.FloatPredicate.html" title="enum inkwell::FloatPredicate">FloatPredicate</a>&gt;</h4></section></summary><div class="docblock"><p>Gets the predicate of an <code>FCmp</code> <code>InstructionValue</code>.
For instance, in the LLVM instruction
<code>%3 = fcmp olt float %0, %1</code>
this gives the <code>olt</code>.</p>
<p>If the instruction is not an <code>FCmp</code>, this returns None.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.has_metadata" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#818-820">source</a><h4 class="code-header">pub fn <a href="#method.has_metadata" class="fn">has_metadata</a>(self) -&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"><p>Determines whether or not this <code>Instruction</code> has any associated metadata.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_metadata" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#824-832">source</a><h4 class="code-header">pub fn <a href="#method.get_metadata" class="fn">get_metadata</a>(self, kind_id: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</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="struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a>&lt;'ctx&gt;&gt;</h4></section></summary><div class="docblock"><p>Gets the <code>MetadataValue</code> associated with this <code>Instruction</code> at a specific
<code>kind_id</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_metadata" class="method"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#836-846">source</a><h4 class="code-header">pub fn <a href="#method.set_metadata" class="fn">set_metadata</a>(
self,
metadata: <a class="struct" href="struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a>&lt;'ctx&gt;,
kind_id: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>,
) -&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>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>&gt;</h4></section></summary><div class="docblock"><p>Determines whether or not this <code>Instruction</code> has any associated metadata
<code>kind_id</code>.</p>
</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-AnyValue%3C'ctx%3E-for-InstructionValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#159">source</a><a href="#impl-AnyValue%3C'ctx%3E-for-InstructionValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.AnyValue.html" title="trait inkwell::values::AnyValue">AnyValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_any_value_enum" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#142-144">source</a><a href="#method.as_any_value_enum" class="anchor">§</a><h4 class="code-header">fn <a href="trait.AnyValue.html#method.as_any_value_enum" class="fn">as_any_value_enum</a>(&amp;self) -&gt; <a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</a>&lt;'ctx&gt;</h4></section></summary><div class='docblock'>Returns an enum containing a typed version of <code>AnyValue</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.print_to_string" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#147-149">source</a><a href="#method.print_to_string" class="anchor">§</a><h4 class="code-header">fn <a href="trait.AnyValue.html#method.print_to_string" class="fn">print_to_string</a>(&amp;self) -&gt; <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></h4></section></summary><div class='docblock'>Prints a value to a <code>LLVMString</code></div></details><details class="toggle method-toggle" open><summary><section id="method.is_poison" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#153-155">source</a><a href="#method.is_poison" class="anchor">§</a><h4 class="code-header">fn <a href="trait.AnyValue.html#method.is_poison" class="fn">is_poison</a>(&amp;self) -&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'>Returns whether the value is <code>poison</code></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsValueRef-for-InstructionValue%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#849-853">source</a><a href="#impl-AsValueRef-for-InstructionValue%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AsValueRef.html" title="trait inkwell::values::AsValueRef">AsValueRef</a> for <a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'_&gt;</h3></section></summary><div class="impl-items"><section id="method.as_value_ref" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#850-852">source</a><a href="#method.as_value_ref" class="anchor">§</a><h4 class="code-header">fn <a href="trait.AsValueRef.html#tymethod.as_value_ref" class="fn">as_value_ref</a>(&amp;self) -&gt; <a class="type" href="../../llvm_sys/prelude/type.LLVMValueRef.html" title="type llvm_sys::prelude::LLVMValueRef">LLVMValueRef</a></h4></section></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-InstructionValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#109">source</a><a href="#impl-Clone-for-InstructionValue%3C'c
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%3CAnyValueEnum%3C'ctx%3E%3E-for-InstructionValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/enums.rs.html#71">source</a><a href="#impl-PartialEq%3CAnyValueEnum%3C'ctx%3E%3E-for-InstructionValue%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>&lt;<a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</a>&lt;'ctx&gt;&gt; for <a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</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/values/enums.rs.html#71">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="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</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><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CInstructionValue%3C'ctx%3E%3E-for-AnyValueEnum%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/enums.rs.html#71">source</a><a href="#impl-PartialEq%3CInstructionValue%3C'ctx%3E%3E-for-AnyValueEnum%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>&lt;<a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt; for <a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq-1" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/enums.rs.html#71">source</a><a href="#method.eq-1" 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.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</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-1" 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-1" 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><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-InstructionValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#109">source</a><a href="#impl-PartialEq-for-InstructionValue%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.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq-2" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/instruction_value.rs.html#109">source</a><a href="#method.eq-2" 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.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</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-2" 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-2" 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><details class="toggle implementors-toggle" open><summary><section id="impl-TryFrom%3CAnyValueEnum%3C'ctx%3E%3E-for-InstructionValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/enums.rs.html#71">source</a><a href="#impl-TryFrom%3CAnyValueEnum%3C'ctx%3E%3E-for-InstructionValue%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/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;<a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</a>&lt;'ctx&gt;&gt; for <a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;</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="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</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="../../src/inkwell/values/enums.rs.html#71">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: <a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</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;Self, Self::<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" open><summary><section id="impl-TryFrom%3CInstructionValue%3C'ctx%3E%3E-for-FloatValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/float_value.rs.html#203-213">source</a><a href="#impl-TryFrom%3CInstructionValue%3C'ctx%3E%3E-for-FloatValue%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/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;<a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt; for <a class="struct" href="struct.FloatValue.html" title="struct inkwell::values::FloatValue">FloatValue</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a href="#associatedtype.Error-2" 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="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</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-2" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/values/float_value.rs.html#206-212">source</a><a href="#method.try_from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.
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-1" 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-1" 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-ToString-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/string.rs.html#2552">source</a><a href="#impl-ToString-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/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<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.to_string" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/string.rs.html#2558">source</a><a href="#method.to_string" class="anchor">§</a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.80.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fn">to_string</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.80.0/alloc/string/trait.ToString.html#tymethod.to_string">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-5" class="associatedtype trait-impl"><a href="#associatedtype.Error-5" 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-5" 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-5" 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-6" class="associatedtype trait-impl"><a href="#associatedtype.Error-6" 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">{"OperandIter<'ctx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.OperandIter.html\" title=\"struct inkwell::values::OperandIter\">OperandIter</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.OperandIter.html\" title=\"struct inkwell::values::OperandIter\">OperandIter</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=\"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=\"enum\" href=\"../../either/enum.Either.html\" title=\"enum either::Either\">Either</a>&lt;<a class=\"enum\" href=\"enum.BasicValueEnum.html\" title=\"enum inkwell::values::BasicValueEnum\">BasicValueEnum</a>&lt;'ctx&gt;, <a class=\"struct\" href=\"../basic_block/struct.BasicBlock.html\" title=\"struct inkwell::basic_block::BasicBlock\">BasicBlock</a>&lt;'ctx&gt;&gt;&gt;;</div>","OperandUseIter<'ctx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.OperandUseIter.html\" title=\"struct inkwell::values::OperandUseIter\">OperandUseIter</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.OperandUseIter.html\" title=\"struct inkwell::values::OperandUseIter\">OperandUseIter</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=\"enum\" href=\"https://doc.rust-lang.org/1.80.0/co