mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-09 17:48:24 +00:00
147 lines
44 KiB
HTML
147 lines
44 KiB
HTML
<!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 usage of a `BasicValue` in another value."><title>BasicValueUse 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="#">BasicValueUse</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.get_next_use">get_next_use</a></li><li><a href="#method.get_used_value">get_used_value</a></li><li><a href="#method.get_user">get_user</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-BasicValueUse%3C'ctx%3E">Clone</a></li><li><a href="#impl-Copy-for-BasicValueUse%3C'ctx%3E">Copy</a></li><li><a href="#impl-Debug-for-BasicValueUse%3C'ctx%3E">Debug</a></li><li><a href="#impl-Eq-for-BasicValueUse%3C'ctx%3E">Eq</a></li><li><a href="#impl-PartialEq-for-BasicValueUse%3C'ctx%3E">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-BasicValueUse%3C'ctx%3E">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Send-for-BasicValueUse%3C'ctx%3E">!Send</a></li><li><a href="#impl-Sync-for-BasicValueUse%3C'ctx%3E">!Sync</a></li><li><a href="#impl-Freeze-for-BasicValueUse%3C'ctx%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-BasicValueUse%3C'ctx%3E">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-BasicValueUse%3C'ctx%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BasicValueUse%3C'ctx%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-IntoEither-for-T">IntoEither</a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In inkwell::values</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">inkwell</a>::<wbr><a href="index.html">values</a>::<wbr><a class="struct" href="#">BasicValueUse</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/inkwell/values/basic_value_use.rs.html#15">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct BasicValueUse<'ctx>(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A usage of a <code>BasicValue</code> in another value.</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-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#17-187">source</a><a href="#impl-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#23-27">source</a><h4 class="code-header">pub unsafe fn <a href="#method.new" class="fn">new</a>(use_: <a class="type" href="../../llvm_sys/prelude/type.LLVMUseRef.html" title="type llvm_sys::prelude::LLVMUseRef">LLVMUseRef</a>) -> Self</h4></section></summary><div class="docblock"><p>Get a value from an <a href="../../llvm_sys/prelude/type.LLVMUseRef.html" title="type llvm_sys::prelude::LLVMUseRef">LLVMUseRef</a>.</p>
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
|
<p>The ref must be valid and of type basic value.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_next_use" class="method"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#85-93">source</a><h4 class="code-header">pub fn <a href="#method.get_next_use" class="fn">get_next_use</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></h4></section></summary><div class="docblock"><p>Gets the next use of a <code>BasicBlock</code>, <code>InstructionValue</code> or <code>BasicValue</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">&</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="kw">let </span>arg1_first_use = arg1.get_first_use().unwrap();
|
|
|
|
<span class="macro">assert!</span>(arg1_first_use.get_next_use().is_some());</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 = 'ivs'
|
|
source_filename = "ivs"
|
|
|
|
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 arg1 (%0) uses clear:</p>
|
|
<ol>
|
|
<li>In the store instruction</li>
|
|
<li>In the pointer bitcast</li>
|
|
</ol>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_user" class="method"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#130-132">source</a><h4 class="code-header">pub fn <a href="#method.get_user" class="fn">get_user</a>(self) -> <a class="enum" href="enum.AnyValueEnum.html" title="enum inkwell::values::AnyValueEnum">AnyValueEnum</a><'ctx></h4></section></summary><div class="docblock"><p>Gets the user (an <code>AnyValueEnum</code>) of this use.</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">&</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="kw">let </span>store_operand_use0 = store_instruction.get_operand_use(<span class="number">0</span>).unwrap();
|
|
<span class="kw">let </span>store_operand_use1 = store_instruction.get_operand_use(<span class="number">1</span>).unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(store_operand_use0.get_user(), store_instruction);
|
|
<span class="macro">assert_eq!</span>(store_operand_use1.get_user(), store_instruction);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_used_value" class="method"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#174-186">source</a><h4 class="code-header">pub fn <a href="#method.get_used_value" class="fn">get_used_value</a>(self) -> <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a><<a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a><'ctx>, <a class="struct" href="../basic_block/struct.BasicBlock.html" title="struct inkwell::basic_block::BasicBlock">BasicBlock</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the used value (a <code>BasicValueEnum</code> or <code>BasicBlock</code>) of this use.</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">&</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="kw">let </span>free_operand0 = free_instruction.get_operand(<span class="number">0</span>).unwrap().left().unwrap();
|
|
<span class="kw">let </span>free_operand0_instruction = free_operand0.as_instruction_value().unwrap();
|
|
<span class="kw">let </span>bitcast_use_value = free_operand0_instruction
|
|
.get_first_use()
|
|
.unwrap()
|
|
.get_used_value()
|
|
.left()
|
|
.unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(bitcast_use_value, free_operand0);</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-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-Clone-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></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/values/basic_value_use.rs.html#14">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>(&self) -> <a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-Debug-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></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/values/basic_value_use.rs.html#14">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>(&self, f: &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><'_>) -> <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-PartialEq-for-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-PartialEq-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></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/basic_value_use.rs.html#14">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>(&self, other: &<a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx>) -> <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>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&Rhs</a>) -> <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-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-Copy-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-Eq-for-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-Eq-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-StructuralPartialEq-for-BasicValueUse%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/basic_value_use.rs.html#14">source</a><a href="#impl-StructuralPartialEq-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></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-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-Freeze-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-RefUnwindSafe-for-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-RefUnwindSafe-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-Send-for-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-Send-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> !<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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-Sync-for-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-Sync-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> !<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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-Unpin-for-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-Unpin-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <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.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section><section id="impl-UnwindSafe-for-BasicValueUse%3C'ctx%3E" class="impl"><a href="#impl-UnwindSafe-for-BasicValueUse%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a><'ctx></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
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>(&self) -> <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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> 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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> 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>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> 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) -> 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<T, 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><U> 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><T>,</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) -> 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><T> 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<T> <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>) -> <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a><Self, Self></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<Self, Self></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<Self, Self></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><F>(self, into_left: F) -> <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a><Self, Self><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">&Self</a>) -> <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<Self, Self></code></a>
|
|
if <code>into_left(&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<Self, Self></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<T> <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>(&self) -> 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>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T, 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><U> 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><T>,</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) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <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><U>>::<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'>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<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> 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><T>,</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> = <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><T>>::<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) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <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><T>>::<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'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |