edlang/inkwell/values/trait.BasicValue.html
2024-07-26 09:42:18 +00:00

12 lines
12 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="Represents a basic value, which can be used both by itself, or in an `AggregateValue`."><title>BasicValue 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 trait"><!--[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="#">BasicValue</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.as_basic_value_enum">as_basic_value_enum</a></li><li><a href="#method.as_instruction_value">as_instruction_value</a></li><li><a href="#method.get_first_use">get_first_use</a></li><li><a href="#method.set_name">set_name</a></li></ul><h3><a href="#implementors">Implementors</a></h3></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>Trait <a href="../index.html">inkwell</a>::<wbr><a href="index.html">values</a>::<wbr><a class="trait" href="#">BasicValue</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/traits.rs.html#90-119">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe trait BasicValue&lt;'ctx&gt;: <a class="trait" href="trait.AnyValue.html" title="trait inkwell::values::AnyValue">AnyValue</a>&lt;'ctx&gt; {
// Provided methods
fn <a href="#method.as_basic_value_enum" class="fn">as_basic_value_enum</a>(&amp;self) -&gt; <a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a>&lt;'ctx&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.as_instruction_value" class="fn">as_instruction_value</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;<a class="struct" href="struct.InstructionValue.html" title="struct inkwell::values::InstructionValue">InstructionValue</a>&lt;'ctx&gt;&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.get_first_use" class="fn">get_first_use</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;<a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a>&lt;'_&gt;&gt; { ... }
<span class="item-spacer"></span> 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>) { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents a basic value, which can be used both by itself, or in an <code>AggregateValue</code>.</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.as_basic_value_enum" class="method"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#92-94">source</a><h4 class="code-header">fn <a href="#method.as_basic_value_enum" class="fn">as_basic_value_enum</a>(&amp;self) -&gt; <a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a>&lt;'ctx&gt;</h4></section></summary><div class="docblock"><p>Returns an enum containing a typed version of the <code>BasicValue</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_instruction_value" class="method"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#98-106">source</a><h4 class="code-header">fn <a href="#method.as_instruction_value" class="fn">as_instruction_value</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;<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>Most <code>BasicValue</code>s are the byproduct of an instruction
and so are convertible into an <code>InstructionValue</code></p>
</div></details><section id="method.get_first_use" class="method"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#108-110">source</a><h4 class="code-header">fn <a href="#method.get_first_use" class="fn">get_first_use</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;<a class="struct" href="struct.BasicValueUse.html" title="struct inkwell::values::BasicValueUse">BasicValueUse</a>&lt;'_&gt;&gt;</h4></section><details class="toggle method-toggle" open><summary><section id="method.set_name" class="method"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#113-115">source</a><h4 class="code-header">fn <a href="#method.set_name" class="fn">set_name</a>(&amp;self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Sets the name of a <code>BasicValue</code>. If the value is a constant, this is a noop.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-BasicValue%3C'ctx%3E-for-AggregateValueEnum%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-AggregateValueEnum%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="enum" href="enum.AggregateValueEnum.html" title="enum inkwell::values::AggregateValueEnum">AggregateValueEnum</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-BasicValueEnum%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-BasicValueEnum%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="enum" href="enum.BasicValueEnum.html" title="enum inkwell::values::BasicValueEnum">BasicValueEnum</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-ArrayValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-ArrayValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.ArrayValue.html" title="struct inkwell::values::ArrayValue">ArrayValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-FloatValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-FloatValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.FloatValue.html" title="struct inkwell::values::FloatValue">FloatValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-GlobalValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-GlobalValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-IntValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-IntValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.IntValue.html" title="struct inkwell::values::IntValue">IntValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-PointerValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-PointerValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.PointerValue.html" title="struct inkwell::values::PointerValue">PointerValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-StructValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-StructValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.StructValue.html" title="struct inkwell::values::StructValue">StructValue</a>&lt;'ctx&gt;</h3></section><section id="impl-BasicValue%3C'ctx%3E-for-VectorValue%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/values/traits.rs.html#160">source</a><a href="#impl-BasicValue%3C'ctx%3E-for-VectorValue%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>&lt;'ctx&gt; for <a class="struct" href="struct.VectorValue.html" title="struct inkwell::values::VectorValue">VectorValue</a>&lt;'ctx&gt;</h3></section></div><script src="../../trait.impl/inkwell/values/traits/trait.BasicValue.js" async></script></section></div></main></body></html>