edlang/inkwell/execution_engine/struct.ExecutionEngine.html
2024-05-05 09:43:20 +00:00

153 lines
53 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 reference-counted wrapper around LLVMs execution engine."><title>ExecutionEngine in inkwell::execution_engine - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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="#">ExecutionEngine</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add_global_mapping">add_global_mapping</a></li><li><a href="#method.add_module">add_module</a></li><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.free_fn_machine_code">free_fn_machine_code</a></li><li><a href="#method.get_function">get_function</a></li><li><a href="#method.get_function_address">get_function_address</a></li><li><a href="#method.get_function_value">get_function_value</a></li><li><a href="#method.get_target_data">get_target_data</a></li><li><a href="#method.link_in_interpreter">link_in_interpreter</a></li><li><a href="#method.link_in_mc_jit">link_in_mc_jit</a></li><li><a href="#method.new">new</a></li><li><a href="#method.remove_module">remove_module</a></li><li><a href="#method.run_function">run_function</a></li><li><a href="#method.run_function_as_main">run_function_as_main</a></li><li><a href="#method.run_static_constructors">run_static_constructors</a></li><li><a href="#method.run_static_destructors">run_static_destructors</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-ExecutionEngine%3C'_%3E">Clone</a></li><li><a href="#impl-Debug-for-ExecutionEngine%3C'ctx%3E">Debug</a></li><li><a href="#impl-Drop-for-ExecutionEngine%3C'_%3E">Drop</a></li><li><a href="#impl-Eq-for-ExecutionEngine%3C'ctx%3E">Eq</a></li><li><a href="#impl-PartialEq-for-ExecutionEngine%3C'ctx%3E">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-ExecutionEngine%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-ExecutionEngine%3C'ctx%3E">!Send</a></li><li><a href="#impl-Sync-for-ExecutionEngine%3C'ctx%3E">!Sync</a></li><li><a href="#impl-Freeze-for-ExecutionEngine%3C'ctx%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ExecutionEngine%3C'ctx%3E">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-ExecutionEngine%3C'ctx%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ExecutionEngine%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&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</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&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In inkwell::execution_engine</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../inkwell/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">inkwell</a>::<wbr><a href="index.html">execution_engine</a>::<wbr><a class="struct" href="#">ExecutionEngine</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/inkwell/execution_engine.rs.html#91-95">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct ExecutionEngine&lt;'ctx&gt; { <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 reference-counted wrapper around LLVMs execution engine.</p>
<h2 id="note"><a class="doc-anchor" href="#note">§</a>Note</h2>
<p>Cloning this object is essentially just a case of copying a couple pointers
and incrementing one or two atomics, so this should be quite cheap to create
copies. The underlying LLVM object will be automatically deallocated when
there are no more references to it.</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-ExecutionEngine%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#97-433">source</a><a href="#impl-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><section id="method.new" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#98-109">source</a><h4 class="code-header">pub unsafe fn <a href="#method.new" class="fn">new</a>(
execution_engine: <a class="struct" href="https://doc.rust-lang.org/1.78.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;<a class="type" href="../../llvm_sys/execution_engine/type.LLVMExecutionEngineRef.html" title="type llvm_sys::execution_engine::LLVMExecutionEngineRef">LLVMExecutionEngineRef</a>&gt;,
jit_mode: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>
) -&gt; Self</h4></section><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#112-114">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fn">as_mut_ptr</a>(&amp;self) -&gt; <a class="type" href="../../llvm_sys/execution_engine/type.LLVMExecutionEngineRef.html" title="type llvm_sys::execution_engine::LLVMExecutionEngineRef">LLVMExecutionEngineRef</a></h4></section></summary><div class="docblock"><p>Acquires the underlying raw pointer belonging to this <code>ExecutionEngine</code> type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.link_in_mc_jit" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#127-129">source</a><h4 class="code-header">pub fn <a href="#method.link_in_mc_jit" class="fn">link_in_mc_jit</a>()</h4></section></summary><div class="docblock"><p>This function probably doesnt need to be called, but is here due to
linking(?) requirements. Bad things happen if we dont provide it.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.link_in_interpreter" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#133-137">source</a><h4 class="code-header">pub fn <a href="#method.link_in_interpreter" class="fn">link_in_interpreter</a>()</h4></section></summary><div class="docblock"><p>This function probably doesnt need to be called, but is here due to
linking(?) requirements. Bad things happen if we dont provide it.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_global_mapping" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#180-182">source</a><h4 class="code-header">pub fn <a href="#method.add_global_mapping" class="fn">add_global_mapping</a>(&amp;self, value: &amp;dyn <a class="trait" href="../values/trait.AnyValue.html" title="trait inkwell::values::AnyValue">AnyValue</a>&lt;'ctx&gt;, addr: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Maps the specified value to an address.</p>
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
<span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::OptimizationLevel;
Target::initialize_native(<span class="kw-2">&amp;</span>InitializationConfig::default()).unwrap();
<span class="kw">extern fn </span>sumf(a: f64, b: f64) -&gt; f64 {
a + b
}
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"test"</span>);
<span class="kw">let </span>builder = context.create_builder();
<span class="kw">let </span>ft = context.f64_type();
<span class="kw">let </span>fnt = ft.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="kw">let </span>f = module.add_function(<span class="string">"test_fn"</span>, fnt, <span class="prelude-val">None</span>);
<span class="kw">let </span>b = context.append_basic_block(f, <span class="string">"entry"</span>);
builder.position_at_end(b);
<span class="kw">let </span>extf = module.add_function(<span class="string">"sumf"</span>, ft.fn_type(<span class="kw-2">&amp;</span>[ft.into(), ft.into()], <span class="bool-val">false</span>), <span class="prelude-val">None</span>);
<span class="kw">let </span>argf = ft.const_float(<span class="number">64.</span>);
<span class="kw">let </span>call_site_value = builder.build_call(extf, <span class="kw-2">&amp;</span>[argf.into(), argf.into()], <span class="string">"retv"</span>).unwrap();
<span class="kw">let </span>retv = call_site_value.try_as_basic_value().left().unwrap().into_float_value();
builder.build_return(<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>retv)).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>ee = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
ee.add_global_mapping(<span class="kw-2">&amp;</span>extf, sumf <span class="kw">as </span>usize);
<span class="kw">let </span>result = <span class="kw">unsafe </span>{ ee.run_function(f, <span class="kw-2">&amp;</span>[]) }.as_float(<span class="kw-2">&amp;</span>ft);
<span class="macro">assert_eq!</span>(result, <span class="number">128.</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_module" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#201-211">source</a><h4 class="code-header">pub fn <a href="#method.add_module" class="fn">add_module</a>(&amp;self, module: &amp;<a class="struct" href="../module/struct.Module.html" title="struct inkwell::module::Module">Module</a>&lt;'ctx&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Adds a module to an <code>ExecutionEngine</code>.</p>
<p>The method will be <code>Ok(())</code> if the module does not belong to an <code>ExecutionEngine</code> already and <code>Err(())</code> otherwise.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
<span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::OptimizationLevel;
Target::initialize_native(<span class="kw-2">&amp;</span>InitializationConfig::default()).unwrap();
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"test"</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ee = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
<span class="macro">assert!</span>(ee.add_module(<span class="kw-2">&amp;</span>module).is_err());</code></pre></div>
</div></details><section id="method.remove_module" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#213-246">source</a><h4 class="code-header">pub fn <a href="#method.remove_module" class="fn">remove_module</a>(
&amp;self,
module: &amp;<a class="struct" href="../module/struct.Module.html" title="struct inkwell::module::Module">Module</a>&lt;'ctx&gt;
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.RemoveModuleError.html" title="enum inkwell::execution_engine::RemoveModuleError">RemoveModuleError</a>&gt;</h4></section><details class="toggle method-toggle" open><summary><section id="method.get_function" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#305-327">source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_function" class="fn">get_function</a>&lt;F&gt;(
&amp;self,
fn_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.JitFunction.html" title="struct inkwell::execution_engine::JitFunction">JitFunction</a>&lt;'ctx, F&gt;, <a class="enum" href="enum.FunctionLookupError.html" title="enum inkwell::execution_engine::FunctionLookupError">FunctionLookupError</a>&gt;<div class="where">where
F: <a class="trait" href="trait.UnsafeFunctionPointer.html" title="trait inkwell::execution_engine::UnsafeFunctionPointer">UnsafeFunctionPointer</a>,</div></h4></section></summary><div class="docblock"><p>Try to load a function from the execution engine.</p>
<p>If a target hasnt already been initialized, spurious “function not
found” errors may be encountered.</p>
<p>The <a href="trait.UnsafeFunctionPointer.html"><code>UnsafeFunctionPointer</code></a> trait is designed so only <code>unsafe extern &quot;C&quot;</code> functions can be retrieved via the <code>get_function()</code> method. If you
get funny type errors then its probably because you have specified the
wrong calling convention or forgotten to specify the retrieved function
as <code>unsafe</code>.</p>
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"test"</span>);
<span class="kw">let </span>builder = context.create_builder();
<span class="comment">// Set up the function signature
</span><span class="kw">let </span>double = context.f64_type();
<span class="kw">let </span>sig = double.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
<span class="comment">// Add the function to our module
</span><span class="kw">let </span>f = module.add_function(<span class="string">"test_fn"</span>, sig, <span class="prelude-val">None</span>);
<span class="kw">let </span>b = context.append_basic_block(f, <span class="string">"entry"</span>);
builder.position_at_end(b);
<span class="comment">// Insert a return statement
</span><span class="kw">let </span>ret = double.const_float(<span class="number">64.0</span>);
builder.build_return(<span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>ret)).unwrap();
<span class="comment">// create the JIT engine
</span><span class="kw">let </span><span class="kw-2">mut </span>ee = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
<span class="comment">// fetch our JIT'd function and execute it
</span><span class="kw">unsafe </span>{
<span class="kw">let </span>test_fn = ee.get_function::&lt;<span class="kw">unsafe extern </span><span class="string">"C" </span><span class="kw">fn</span>() -&gt; f64&gt;(<span class="string">"test_fn"</span>).unwrap();
<span class="kw">let </span>return_value = test_fn.call();
<span class="macro">assert_eq!</span>(return_value, <span class="number">64.0</span>);
}</code></pre></div>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>It is the callers responsibility to ensure they call the function with
the correct signature and calling convention.</p>
<p>The <code>JitFunction</code> wrapper ensures a function wont accidentally outlive the
execution engine it came from, but adding functions after calling this
method <em>may</em> invalidate the function pointer.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_function_address" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#334-352">source</a><h4 class="code-header">pub fn <a href="#method.get_function_address" class="fn">get_function_address</a>(
&amp;self,
fn_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.usize.html">usize</a>, <a class="enum" href="enum.FunctionLookupError.html" title="enum inkwell::execution_engine::FunctionLookupError">FunctionLookupError</a>&gt;</h4></section></summary><div class="docblock"><p>Attempts to look up a functions address by its name. May return Err if the function cannot be
found or some other unknown error has occurred.</p>
<p>It is recommended to use <code>get_function</code> instead of this method when intending to call the function
pointer so that you dont have to do error-prone transmutes yourself.</p>
</div></details><section id="method.get_target_data" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#356-360">source</a><h4 class="code-header">pub fn <a href="#method.get_target_data" class="fn">get_target_data</a>(&amp;self) -&gt; &amp;<a class="struct" href="../targets/struct.TargetData.html" title="struct inkwell::targets::TargetData">TargetData</a></h4></section><section id="method.get_function_value" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#366-381">source</a><h4 class="code-header">pub fn <a href="#method.get_function_value" class="fn">get_function_value</a>(
&amp;self,
fn_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>&lt;'ctx&gt;, <a class="enum" href="enum.FunctionLookupError.html" title="enum inkwell::execution_engine::FunctionLookupError">FunctionLookupError</a>&gt;</h4></section><section id="method.run_function" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#385-400">source</a><h4 class="code-header">pub unsafe fn <a href="#method.run_function" class="fn">run_function</a>(
&amp;self,
function: <a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>&lt;'ctx&gt;,
args: &amp;[&amp;<a class="struct" href="../values/struct.GenericValue.html" title="struct inkwell::values::GenericValue">GenericValue</a>&lt;'ctx&gt;]
) -&gt; <a class="struct" href="../values/struct.GenericValue.html" title="struct inkwell::values::GenericValue">GenericValue</a>&lt;'ctx&gt;</h4></section><section id="method.run_function_as_main" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#405-418">source</a><h4 class="code-header">pub unsafe fn <a href="#method.run_function_as_main" class="fn">run_function_as_main</a>(
&amp;self,
function: <a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>&lt;'ctx&gt;,
args: &amp;[&amp;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>]
) -&gt; <a class="type" href="../../libc/unix/type.c_int.html" title="type libc::unix::c_int">c_int</a></h4></section><section id="method.free_fn_machine_code" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#420-422">source</a><h4 class="code-header">pub fn <a href="#method.free_fn_machine_code" class="fn">free_fn_machine_code</a>(&amp;self, function: <a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>&lt;'ctx&gt;)</h4></section><section id="method.run_static_constructors" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#425-427">source</a><h4 class="code-header">pub fn <a href="#method.run_static_constructors" class="fn">run_static_constructors</a>(&amp;self)</h4></section><section id="method.run_static_destructors" class="method"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#430-432">source</a><h4 class="code-header">pub fn <a href="#method.run_static_destructors" class="fn">run_static_destructors</a>(&amp;self)</h4></section></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-ExecutionEngine%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#452-458">source</a><a href="#impl-Clone-for-ExecutionEngine%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'_&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#453-457">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.78.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.78.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.78.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.78.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-ExecutionEngine%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#90">source</a><a href="#impl-Debug-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#90">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.78.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.78.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.78.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-Drop-for-ExecutionEngine%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#437-450">source</a><a href="#impl-Drop-for-ExecutionEngine%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'_&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#438-449">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&amp;mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.78.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-ExecutionEngine%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#90">source</a><a href="#impl-PartialEq-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</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/execution_engine.rs.html#90">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.78.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.0/std/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.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-Eq-for-ExecutionEngine%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#90">source</a><a href="#impl-Eq-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-StructuralPartialEq-for-ExecutionEngine%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/execution_engine.rs.html#90">source</a><a href="#impl-StructuralPartialEq-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-Freeze-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-RefUnwindSafe-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-RefUnwindSafe-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-Send-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-Send-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; !<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-Sync-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-Sync-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; !<a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-Unpin-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-Unpin-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</h3></section><section id="impl-UnwindSafe-for-ExecutionEngine%3C'ctx%3E" class="impl"><a href="#impl-UnwindSafe-for-ExecutionEngine%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'ctx&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>&lt;'ctx&gt;</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.78.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.0/std/primitive.reference.html">&amp;Self</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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-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.78.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.78.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.78.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.78.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.78.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.78.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.78.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.78.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.78.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></section></div></main></body></html>