mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
589 lines
109 KiB
HTML
589 lines
109 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 reference to an LLVM `Module`. The underlying module will be disposed when dropping this object."><title>Module in inkwell::module - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.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.77.2 (25ef9e3d8 2024-04-09)" data-channel="1.77.2" data-search-js="search-dd67cee4cfa65049.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-48f368f3872407c8.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="#">Module</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add_basic_value_flag">add_basic_value_flag</a></li><li><a href="#method.add_function">add_function</a></li><li><a href="#method.add_global">add_global</a></li><li><a href="#method.add_global_metadata">add_global_metadata</a></li><li><a href="#method.add_metadata_flag">add_metadata_flag</a></li><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.create_debug_info_builder">create_debug_info_builder</a></li><li><a href="#method.create_execution_engine">create_execution_engine</a></li><li><a href="#method.create_interpreter_execution_engine">create_interpreter_execution_engine</a></li><li><a href="#method.create_jit_execution_engine">create_jit_execution_engine</a></li><li><a href="#method.get_context">get_context</a></li><li><a href="#method.get_data_layout">get_data_layout</a></li><li><a href="#method.get_debug_metadata_version">get_debug_metadata_version</a></li><li><a href="#method.get_first_function">get_first_function</a></li><li><a href="#method.get_first_global">get_first_global</a></li><li><a href="#method.get_flag">get_flag</a></li><li><a href="#method.get_function">get_function</a></li><li><a href="#method.get_functions">get_functions</a></li><li><a href="#method.get_global">get_global</a></li><li><a href="#method.get_global_metadata">get_global_metadata</a></li><li><a href="#method.get_global_metadata_size">get_global_metadata_size</a></li><li><a href="#method.get_globals">get_globals</a></li><li><a href="#method.get_last_function">get_last_function</a></li><li><a href="#method.get_last_global">get_last_global</a></li><li><a href="#method.get_name">get_name</a></li><li><a href="#method.get_or_insert_comdat">get_or_insert_comdat</a></li><li><a href="#method.get_source_file_name">get_source_file_name</a></li><li><a href="#method.get_struct_type">get_struct_type</a></li><li><a href="#method.get_triple">get_triple</a></li><li><a href="#method.link_in_module">link_in_module</a></li><li><a href="#method.new">new</a></li><li><a href="#method.parse_bitcode_from_buffer">parse_bitcode_from_buffer</a></li><li><a href="#method.parse_bitcode_from_path">parse_bitcode_from_path</a></li><li><a href="#method.print_to_file">print_to_file</a></li><li><a href="#method.print_to_stderr">print_to_stderr</a></li><li><a href="#method.print_to_string">print_to_string</a></li><li><a href="#method.run_passes">run_passes</a></li><li><a href="#method.set_data_layout">set_data_layout</a></li><li><a href="#method.set_inline_assembly">set_inline_assembly</a></li><li><a href="#method.set_name">set_name</a></li><li><a href="#method.set_source_file_name">set_source_file_name</a></li><li><a href="#method.set_triple">set_triple</a></li><li><a href="#method.strip_debug_info">strip_debug_info</a></li><li><a href="#method.to_string">to_string</a></li><li><a href="#method.verify">verify</a></li><li><a href="#method.write_bitcode_to_file">write_bitcode_to_file</a></li><li><a href="#method.write_bitcode_to_memory">write_bitcode_to_memory</a></li><li><a href="#method.write_bitcode_to_path">write_bitcode_to_path</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Module%3C'_%3E">Clone</a></li><li><a href="#impl-Debug-for-Module%3C'ctx%3E">Debug</a></li><li><a href="#impl-Drop-for-Module%3C'_%3E">Drop</a></li><li><a href="#impl-Eq-for-Module%3C'ctx%3E">Eq</a></li><li><a href="#impl-PartialEq-for-Module%3C'ctx%3E">PartialEq</a></li><li><a href="#impl-PassManagerSubType-for-Module%3C'_%3E">PassManagerSubType</a></li><li><a href="#impl-StructuralPartialEq-for-Module%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-RefUnwindSafe-for-Module%3C'ctx%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Module%3C'ctx%3E">!Send</a></li><li><a href="#impl-Sync-for-Module%3C'ctx%3E">!Sync</a></li><li><a href="#impl-Unpin-for-Module%3C'ctx%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Module%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::module</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">module</a>::<wbr><a class="struct" href="#">Module</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/module.rs.html#168-173">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Module<'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>Represents a reference to an LLVM <code>Module</code>.
|
||
The underlying module will be disposed when dropping this object.</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-Module%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#175-1518">source</a><a href="#impl-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</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/module.rs.html#181-190">source</a><h4 class="code-header">pub unsafe fn <a href="#method.new" class="fn">new</a>(module: <a class="type" href="../../llvm_sys/prelude/type.LLVMModuleRef.html" title="type llvm_sys::prelude::LLVMModuleRef">LLVMModuleRef</a>) -> Self</h4></section></summary><div class="docblock"><p>Get a module from an <a href="../../llvm_sys/prelude/type.LLVMModuleRef.html" title="type llvm_sys::prelude::LLVMModuleRef">LLVMModuleRef</a>.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>The ref must be valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#193-195">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fn">as_mut_ptr</a>(&self) -> <a class="type" href="../../llvm_sys/prelude/type.LLVMModuleRef.html" title="type llvm_sys::prelude::LLVMModuleRef">LLVMModuleRef</a></h4></section></summary><div class="docblock"><p>Acquires the underlying raw pointer belonging to this <code>Module</code> type.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_function" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#218-230">source</a><h4 class="code-header">pub fn <a href="#method.add_function" class="fn">add_function</a>(
|
||
&self,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
ty: <a class="struct" href="../types/struct.FunctionType.html" title="struct inkwell::types::FunctionType">FunctionType</a><'ctx>,
|
||
linkage: <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>>
|
||
) -> <a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a><'ctx></h4></section></summary><div class="docblock"><p>Creates a function given its <code>name</code> and <code>ty</code>, adds it to the <code>Module</code>
|
||
and returns it.</p>
|
||
<p>An optional <code>linkage</code> can be specified, without which the default value
|
||
<code>Linkage::ExternalLinkage</code> will be used.</p>
|
||
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::{Module, Linkage};
|
||
<span class="kw">use </span>inkwell::types::FunctionType;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
|
||
<span class="kw">let </span>fn_type = context.f32_type().fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>fn_val = module.add_function(<span class="string">"my_function"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(fn_val.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_function"</span>));
|
||
<span class="macro">assert_eq!</span>(fn_val.get_linkage(), Linkage::External);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_context" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#244-246">source</a><h4 class="code-header">pub fn <a href="#method.get_context" class="fn">get_context</a>(&self) -> <a class="struct" href="../context/struct.ContextRef.html" title="struct inkwell::context::ContextRef">ContextRef</a><'ctx></h4></section></summary><div class="docblock"><p>Gets the <code>Context</code> from which this <code>Module</code> originates.</p>
|
||
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::{Context, ContextRef};
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
|
||
<span class="kw">let </span>local_context = Context::create();
|
||
<span class="kw">let </span>local_module = local_context.create_module(<span class="string">"my_module"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(local_module.get_context(), local_context);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_first_function" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#266-268">source</a><h4 class="code-header">pub fn <a href="#method.get_first_function" class="fn">get_first_function</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the first <code>FunctionValue</code> defined in this <code>Module</code>.</p>
|
||
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_first_function().is_none());
|
||
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>fn_value = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(fn_value, module.get_first_function().unwrap());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_last_function" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#288-290">source</a><h4 class="code-header">pub fn <a href="#method.get_last_function" class="fn">get_last_function</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the last <code>FunctionValue</code> defined in this <code>Module</code>.</p>
|
||
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_last_function().is_none());
|
||
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>fn_value = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(fn_value, module.get_last_function().unwrap());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_function" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#310-314">source</a><h4 class="code-header">pub fn <a href="#method.get_function" class="fn">get_function</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets a <code>FunctionValue</code> defined in this <code>Module</code> by its name.</p>
|
||
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_function(<span class="string">"my_fn"</span>).is_none());
|
||
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>fn_value = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(fn_value, module.get_function(<span class="string">"my_fn"</span>).unwrap());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_functions" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#338-340">source</a><h4 class="code-header">pub fn <a href="#method.get_functions" class="fn">get_functions</a>(&self) -> <a class="struct" href="struct.FunctionIterator.html" title="struct inkwell::module::FunctionIterator">FunctionIterator</a><'ctx> <a href="#" class="tooltip" data-notable-ty="FunctionIterator<'ctx>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator over the functions in this <code>Module</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_function(<span class="string">"my_fn"</span>).is_none());
|
||
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>fn_value = module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
|
||
<span class="kw">let </span>names: Vec<String> = module
|
||
.get_functions()
|
||
.map(|f| f.get_name().to_string_lossy().to_string())
|
||
.collect();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="string">"my_fn"</span>.to_owned()], names);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_struct_type" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#389-391">source</a><h4 class="code-header">pub fn <a href="#method.get_struct_type" class="fn">get_struct_type</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../types/struct.StructType.html" title="struct inkwell::types::StructType">StructType</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets a named <code>StructType</code> from this <code>Module</code>’s <code>Context</code>.</p>
|
||
<h5 id="example-5"><a class="doc-anchor" href="#example-5">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_struct_type(<span class="string">"foo"</span>).is_none());
|
||
|
||
<span class="kw">let </span>opaque = context.opaque_struct_type(<span class="string">"foo"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_struct_type(<span class="string">"foo"</span>).unwrap(), opaque);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_triple" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#412-414">source</a><h4 class="code-header">pub fn <a href="#method.set_triple" class="fn">set_triple</a>(&self, triple: &<a class="struct" href="../targets/struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a>)</h4></section></summary><div class="docblock"><p>Assigns a <code>TargetTriple</code> to this <code>Module</code>.</p>
|
||
<h5 id="example-6"><a class="doc-anchor" href="#example-6">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::targets::{Target, TargetTriple};
|
||
|
||
Target::initialize_x86(<span class="kw-2">&</span>Default::default());
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>triple = TargetTriple::create(<span class="string">"x86_64-pc-linux-gnu"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_triple(), TargetTriple::create(<span class="string">""</span>));
|
||
|
||
module.set_triple(<span class="kw-2">&</span>triple);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_triple(), triple);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_triple" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#436-441">source</a><h4 class="code-header">pub fn <a href="#method.get_triple" class="fn">get_triple</a>(&self) -> <a class="struct" href="../targets/struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a></h4></section></summary><div class="docblock"><p>Gets the <code>TargetTriple</code> assigned to this <code>Module</code>. If none has been
|
||
assigned, the triple will default to “”.</p>
|
||
<h5 id="example-7"><a class="doc-anchor" href="#example-7">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::targets::{Target, TargetTriple};
|
||
|
||
Target::initialize_x86(<span class="kw-2">&</span>Default::default());
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>triple = TargetTriple::create(<span class="string">"x86_64-pc-linux-gnu"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_triple(), TargetTriple::create(<span class="string">""</span>));
|
||
|
||
module.set_triple(<span class="kw-2">&</span>triple);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_triple(), triple);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.create_execution_engine" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#460-495">source</a><h4 class="code-header">pub fn <a href="#method.create_execution_engine" class="fn">create_execution_engine</a>(
|
||
&self
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a><'ctx>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Creates an <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
<h5 id="example-8"><a class="doc-anchor" href="#example-8">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
<span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
|
||
|
||
Target::initialize_native(<span class="kw-2">&</span>InitializationConfig::default()).expect(<span class="string">"Failed to initialize native target"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>execution_engine = module.create_execution_engine().unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_context(), context);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.create_interpreter_execution_engine" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#514-550">source</a><h4 class="code-header">pub fn <a href="#method.create_interpreter_execution_engine" class="fn">create_interpreter_execution_engine</a>(
|
||
&self
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a><'ctx>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Creates an interpreter <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
<h5 id="example-9"><a class="doc-anchor" href="#example-9">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
<span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
|
||
|
||
Target::initialize_native(<span class="kw-2">&</span>InitializationConfig::default()).expect(<span class="string">"Failed to initialize native target"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>execution_engine = module.create_interpreter_execution_engine().unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_context(), context);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.create_jit_execution_engine" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#570-610">source</a><h4 class="code-header">pub fn <a href="#method.create_jit_execution_engine" class="fn">create_jit_execution_engine</a>(
|
||
&self,
|
||
opt_level: <a class="enum" href="../enum.OptimizationLevel.html" title="enum inkwell::OptimizationLevel">OptimizationLevel</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a><'ctx>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Creates a JIT <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
<h5 id="example-10"><a class="doc-anchor" href="#example-10">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::OptimizationLevel;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
<span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
|
||
|
||
Target::initialize_native(<span class="kw-2">&</span>InitializationConfig::default()).expect(<span class="string">"Failed to initialize native target"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>execution_engine = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_context(), context);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_global" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#628-649">source</a><h4 class="code-header">pub fn <a href="#method.add_global" class="fn">add_global</a><T: <a class="trait" href="../types/trait.BasicType.html" title="trait inkwell::types::BasicType">BasicType</a><'ctx>>(
|
||
&self,
|
||
type_: T,
|
||
address_space: <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../struct.AddressSpace.html" title="struct inkwell::AddressSpace">AddressSpace</a>>,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>
|
||
) -> <a class="struct" href="../values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a><'ctx></h4></section></summary><div class="docblock"><p>Creates a <code>GlobalValue</code> based on a type in an address space.</p>
|
||
<h5 id="example-11"><a class="doc-anchor" href="#example-11">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::AddressSpace;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>i8_type = context.i8_type();
|
||
<span class="kw">let </span>global = module.add_global(i8_type, <span class="prelude-val">Some</span>(AddressSpace::from(<span class="number">1u16</span>)), <span class="string">"my_global"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_first_global().unwrap(), global);
|
||
<span class="macro">assert_eq!</span>(module.get_last_global().unwrap(), global);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_bitcode_to_path" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#670-675">source</a><h4 class="code-header">pub fn <a href="#method.write_bitcode_to_path" class="fn">write_bitcode_to_path</a>(&self, path: &<a class="struct" href="https://doc.rust-lang.org/1.77.2/std/path/struct.Path.html" title="struct std::path::Path">Path</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Writes a <code>Module</code> to a <code>Path</code>.</p>
|
||
<h5 id="example-12"><a class="doc-anchor" href="#example-12">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">use </span>std::path::Path;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>path = Path::new(<span class="string">"module.bc"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
||
module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
module.write_bitcode_to_path(<span class="kw-2">&</span>path);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_bitcode_to_file" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#679-698">source</a><h4 class="code-header">pub fn <a href="#method.write_bitcode_to_file" class="fn">write_bitcode_to_file</a>(
|
||
&self,
|
||
file: &<a class="struct" href="https://doc.rust-lang.org/1.77.2/std/fs/struct.File.html" title="struct std::fs::File">File</a>,
|
||
should_close: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>,
|
||
unbuffered: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>
|
||
) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p><code>write_bitcode_to_path</code> should be preferred over this method, as it does not work on all operating systems.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_bitcode_to_memory" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#720-724">source</a><h4 class="code-header">pub fn <a href="#method.write_bitcode_to_memory" class="fn">write_bitcode_to_memory</a>(&self) -> <a class="struct" href="../memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a></h4></section></summary><div class="docblock"><p>Writes this <code>Module</code> to a <code>MemoryBuffer</code>.</p>
|
||
<h5 id="example-13"><a class="doc-anchor" href="#example-13">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>void_type = context.void_type();
|
||
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>f = module.add_function(<span class="string">"f"</span>, fn_type, <span class="prelude-val">None</span>);
|
||
<span class="kw">let </span>basic_block = context.append_basic_block(f, <span class="string">"entry"</span>);
|
||
<span class="kw">let </span>builder = context.create_builder();
|
||
|
||
builder.position_at_end(basic_block);
|
||
builder.build_return(<span class="prelude-val">None</span>);
|
||
|
||
<span class="kw">let </span>buffer = module.write_bitcode_to_memory();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.verify" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#731-744">source</a><h4 class="code-header">pub fn <a href="#method.verify" class="fn">verify</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Ensures that the current <code>Module</code> is valid, and returns a <code>Result</code>
|
||
that describes whether or not it is, returning a LLVM allocated string on error.</p>
|
||
<h5 id="remarks"><a class="doc-anchor" href="#remarks">§</a>Remarks</h5>
|
||
<p>See also: http://llvm.org/doxygen/Analysis_2Analysis_8cpp_source.html</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_data_layout" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#777-781">source</a><h4 class="code-header">pub fn <a href="#method.get_data_layout" class="fn">get_data_layout</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.77.2/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><'_, <a class="struct" href="../data_layout/struct.DataLayout.html" title="struct inkwell::data_layout::DataLayout">DataLayout</a>></h4></section></summary><div class="docblock"><p>Gets a smart pointer to the <code>DataLayout</code> belonging to a particular <code>Module</code>.</p>
|
||
<h5 id="example-14"><a class="doc-anchor" href="#example-14">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::OptimizationLevel;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
|
||
|
||
Target::initialize_native(<span class="kw-2">&</span>InitializationConfig::default()).expect(<span class="string">"Failed to initialize native target"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"sum"</span>);
|
||
<span class="kw">let </span>execution_engine = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
|
||
<span class="kw">let </span>target_data = execution_engine.get_target_data();
|
||
<span class="kw">let </span>data_layout = target_data.get_data_layout();
|
||
|
||
module.set_data_layout(<span class="kw-2">&</span>data_layout);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>module.get_data_layout(), data_layout);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_data_layout" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#806-812">source</a><h4 class="code-header">pub fn <a href="#method.set_data_layout" class="fn">set_data_layout</a>(&self, data_layout: &<a class="struct" href="../data_layout/struct.DataLayout.html" title="struct inkwell::data_layout::DataLayout">DataLayout</a>)</h4></section></summary><div class="docblock"><p>Sets the <code>DataLayout</code> for a particular <code>Module</code>.</p>
|
||
<h5 id="example-15"><a class="doc-anchor" href="#example-15">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::OptimizationLevel;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::targets::{InitializationConfig, Target};
|
||
|
||
Target::initialize_native(<span class="kw-2">&</span>InitializationConfig::default()).expect(<span class="string">"Failed to initialize native target"</span>);
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"sum"</span>);
|
||
<span class="kw">let </span>execution_engine = module.create_jit_execution_engine(OptimizationLevel::None).unwrap();
|
||
<span class="kw">let </span>target_data = execution_engine.get_target_data();
|
||
<span class="kw">let </span>data_layout = target_data.get_data_layout();
|
||
|
||
module.set_data_layout(<span class="kw-2">&</span>data_layout);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>module.get_data_layout(), data_layout);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.print_to_stderr" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#815-819">source</a><h4 class="code-header">pub fn <a href="#method.print_to_stderr" class="fn">print_to_stderr</a>(&self)</h4></section></summary><div class="docblock"><p>Prints the content of the <code>Module</code> to stderr.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.print_to_string" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#822-824">source</a><h4 class="code-header">pub fn <a href="#method.print_to_string" class="fn">print_to_string</a>(&self) -> <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></h4></section></summary><div class="docblock"><p>Prints the content of the <code>Module</code> to an <code>LLVMString</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.print_to_file" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#827-849">source</a><h4 class="code-header">pub fn <a href="#method.print_to_file" class="fn">print_to_file</a><P: <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.77.2/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(&self, path: P) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Prints the content of the <code>Module</code> to a file.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.to_string" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#852-854">source</a><h4 class="code-header">pub fn <a href="#method.to_string" class="fn">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.77.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Prints the content of the <code>Module</code> to a <code>String</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_inline_assembly" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#857-872">source</a><h4 class="code-header">pub fn <a href="#method.set_inline_assembly" class="fn">set_inline_assembly</a>(&self, asm: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Sets the inline assembly for the <code>Module</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_global_metadata" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#914-925">source</a><h4 class="code-header">pub fn <a href="#method.add_global_metadata" class="fn">add_global_metadata</a>(
|
||
&self,
|
||
key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
metadata: &<a class="struct" href="../values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a><'ctx>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a>, &'static <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>></h4></section></summary><div class="docblock"><p>Appends a <code>MetaDataValue</code> to a global list indexed by a particular key.</p>
|
||
<h5 id="example-16"><a class="doc-anchor" href="#example-16">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>bool_type = context.bool_type();
|
||
<span class="kw">let </span>f32_type = context.f32_type();
|
||
<span class="kw">let </span>bool_val = bool_type.const_int(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>f32_val = f32_type.const_float(<span class="number">0.0</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
||
<span class="kw">let </span>md_string = context.metadata_string(<span class="string">"lots of metadata here"</span>);
|
||
<span class="kw">let </span>md_node = context.metadata_node(<span class="kw-2">&</span>[bool_val.into(), f32_val.into()]);
|
||
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_string).unwrap();
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_node).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>global_md = module.get_global_metadata(<span class="string">"my_md"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(global_md.len(), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>(md_0, md_1) = (global_md[<span class="number">0</span>].get_node_values(), global_md[<span class="number">1</span>].get_node_values());
|
||
|
||
<span class="macro">assert_eq!</span>(md_0.len(), <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(md_1.len(), <span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(md_0[<span class="number">0</span>].into_metadata_value().get_string_value(), md_string.get_string_value());
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">0</span>].into_int_value(), bool_val);
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">1</span>].into_float_value(), f32_val);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_global_metadata_size" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#964-968">source</a><h4 class="code-header">pub fn <a href="#method.get_global_metadata_size" class="fn">get_global_metadata_size</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Obtains the number of <code>MetaDataValue</code>s indexed by a particular key.</p>
|
||
<h5 id="example-17"><a class="doc-anchor" href="#example-17">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>bool_type = context.bool_type();
|
||
<span class="kw">let </span>f32_type = context.f32_type();
|
||
<span class="kw">let </span>bool_val = bool_type.const_int(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>f32_val = f32_type.const_float(<span class="number">0.0</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
||
<span class="kw">let </span>md_string = context.metadata_string(<span class="string">"lots of metadata here"</span>);
|
||
<span class="kw">let </span>md_node = context.metadata_node(<span class="kw-2">&</span>[bool_val.into(), f32_val.into()]);
|
||
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_string).unwrap();
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_node).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>global_md = module.get_global_metadata(<span class="string">"my_md"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(global_md.len(), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>(md_0, md_1) = (global_md[<span class="number">0</span>].get_node_values(), global_md[<span class="number">1</span>].get_node_values());
|
||
|
||
<span class="macro">assert_eq!</span>(md_0.len(), <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(md_1.len(), <span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(md_0[<span class="number">0</span>].into_metadata_value().get_string_value(), md_string.get_string_value());
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">0</span>].into_int_value(), bool_val);
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">1</span>].into_float_value(), f32_val);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_global_metadata" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1007-1021">source</a><h4 class="code-header">pub fn <a href="#method.get_global_metadata" class="fn">get_global_metadata</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.77.2/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Obtains the global <code>MetaDataValue</code> node indexed by key, which may contain 1 string or multiple values as its <code>get_node_values()</code></p>
|
||
<h5 id="example-18"><a class="doc-anchor" href="#example-18">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
<span class="kw">let </span>bool_type = context.bool_type();
|
||
<span class="kw">let </span>f32_type = context.f32_type();
|
||
<span class="kw">let </span>bool_val = bool_type.const_int(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
<span class="kw">let </span>f32_val = f32_type.const_float(<span class="number">0.0</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
||
<span class="kw">let </span>md_string = context.metadata_string(<span class="string">"lots of metadata here"</span>);
|
||
<span class="kw">let </span>md_node = context.metadata_node(<span class="kw-2">&</span>[bool_val.into(), f32_val.into()]);
|
||
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_string).unwrap();
|
||
module.add_global_metadata(<span class="string">"my_md"</span>, <span class="kw-2">&</span>md_node).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global_metadata_size(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>global_md = module.get_global_metadata(<span class="string">"my_md"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(global_md.len(), <span class="number">2</span>);
|
||
|
||
<span class="kw">let </span>(md_0, md_1) = (global_md[<span class="number">0</span>].get_node_values(), global_md[<span class="number">1</span>].get_node_values());
|
||
|
||
<span class="macro">assert_eq!</span>(md_0.len(), <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(md_1.len(), <span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(md_0[<span class="number">0</span>].into_metadata_value().get_string_value(), md_string.get_string_value());
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">0</span>].into_int_value(), bool_val);
|
||
<span class="macro">assert_eq!</span>(md_1[<span class="number">1</span>].into_float_value(), f32_val);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_first_global" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1041-1049">source</a><h4 class="code-header">pub fn <a href="#method.get_first_global" class="fn">get_first_global</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the first <code>GlobalValue</code> in a module.</p>
|
||
<h5 id="example-19"><a class="doc-anchor" href="#example-19">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::AddressSpace;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>i8_type = context.i8_type();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.get_first_global().is_none());
|
||
|
||
<span class="kw">let </span>global = module.add_global(i8_type, <span class="prelude-val">Some</span>(AddressSpace::from(<span class="number">4u16</span>)), <span class="string">"my_global"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_first_global().unwrap(), global);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_last_global" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1069-1077">source</a><h4 class="code-header">pub fn <a href="#method.get_last_global" class="fn">get_last_global</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the last <code>GlobalValue</code> in a module.</p>
|
||
<h5 id="example-20"><a class="doc-anchor" href="#example-20">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::AddressSpace;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>i8_type = context.i8_type();
|
||
|
||
<span class="macro">assert!</span>(module.get_last_global().is_none());
|
||
|
||
<span class="kw">let </span>global = module.add_global(i8_type, <span class="prelude-val">Some</span>(AddressSpace::from(<span class="number">4u16</span>)), <span class="string">"my_global"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_last_global().unwrap(), global);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_global" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1097-1106">source</a><h4 class="code-header">pub fn <a href="#method.get_global" class="fn">get_global</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets a named <code>GlobalValue</code> in a module.</p>
|
||
<h5 id="example-21"><a class="doc-anchor" href="#example-21">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::AddressSpace;
|
||
<span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>i8_type = context.i8_type();
|
||
|
||
<span class="macro">assert!</span>(module.get_global(<span class="string">"my_global"</span>).is_none());
|
||
|
||
<span class="kw">let </span>global = module.add_global(i8_type, <span class="prelude-val">Some</span>(AddressSpace::from(<span class="number">4u16</span>)), <span class="string">"my_global"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_global(<span class="string">"my_global"</span>).unwrap(), global);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_globals" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1109-1111">source</a><h4 class="code-header">pub fn <a href="#method.get_globals" class="fn">get_globals</a>(&self) -> <a class="struct" href="struct.GlobalIterator.html" title="struct inkwell::module::GlobalIterator">GlobalIterator</a><'ctx> <a href="#" class="tooltip" data-notable-ty="GlobalIterator<'ctx>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator over the globals in this <code>Module</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_bitcode_from_buffer" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1131-1158">source</a><h4 class="code-header">pub fn <a href="#method.parse_bitcode_from_buffer" class="fn">parse_bitcode_from_buffer</a>(
|
||
buffer: &<a class="struct" href="../memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a>,
|
||
context: impl <a class="trait" href="../context/trait.AsContextRef.html" title="trait inkwell::context::AsContextRef">AsContextRef</a><'ctx>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Module</code> from a <code>MemoryBuffer</code> with bitcode.</p>
|
||
<h5 id="example-22"><a class="doc-anchor" href="#example-22">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
<span class="kw">use </span>inkwell::memory_buffer::MemoryBuffer;
|
||
<span class="kw">use </span>std::path::Path;
|
||
|
||
<span class="kw">let </span>path = Path::new(<span class="string">"foo/bar.bc"</span>);
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>buffer = MemoryBuffer::create_from_file(<span class="kw-2">&</span>path).unwrap();
|
||
<span class="kw">let </span>module = Module::parse_bitcode_from_buffer(<span class="kw-2">&</span>buffer, <span class="kw-2">&</span>context);
|
||
|
||
<span class="macro">assert_eq!</span>(module.unwrap().get_context(), context);
|
||
</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_bitcode_from_path" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1178-1185">source</a><h4 class="code-header">pub fn <a href="#method.parse_bitcode_from_path" class="fn">parse_bitcode_from_path</a><P: <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/1.77.2/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(
|
||
path: P,
|
||
context: impl <a class="trait" href="../context/trait.AsContextRef.html" title="trait inkwell::context::AsContextRef">AsContextRef</a><'ctx>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>A convenience function for creating a <code>Module</code> from a bitcode file for a given context.</p>
|
||
<h5 id="example-23"><a class="doc-anchor" href="#example-23">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
<span class="kw">use </span>inkwell::module::Module;
|
||
<span class="kw">use </span>std::path::Path;
|
||
|
||
<span class="kw">let </span>path = Path::new(<span class="string">"foo/bar.bc"</span>);
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = Module::parse_bitcode_from_path(<span class="kw-2">&</span>path, <span class="kw-2">&</span>context);
|
||
|
||
<span class="macro">assert_eq!</span>(module.unwrap().get_context(), context);
|
||
</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_name" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1199-1204">source</a><h4 class="code-header">pub fn <a href="#method.get_name" class="fn">get_name</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.77.2/core/ffi/c_str/struct.CStr.html" title="struct core::ffi::c_str::CStr">CStr</a></h4></section></summary><div class="docblock"><p>Gets the name of this <code>Module</code>.</p>
|
||
<h5 id="example-24"><a class="doc-anchor" href="#example-24">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mdoule"</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_name" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1220-1222">source</a><h4 class="code-header">pub fn <a href="#method.set_name" class="fn">set_name</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Assigns the name of this <code>Module</code>.</p>
|
||
<h5 id="example-25"><a class="doc-anchor" href="#example-25">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
|
||
|
||
module.set_name(<span class="string">"my_module2"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_module2"</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_source_file_name" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1242-1249">source</a><h4 class="code-header">pub fn <a href="#method.get_source_file_name" class="fn">get_source_file_name</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.77.2/core/ffi/c_str/struct.CStr.html" title="struct core::ffi::c_str::CStr">CStr</a></h4></section></summary><div class="docblock"><p>Gets the source file name. It defaults to the module identifier but is separate from it.</p>
|
||
<h5 id="example-26"><a class="doc-anchor" href="#example-26">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_source_file_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod"</span>));
|
||
|
||
module.set_source_file_name(<span class="string">"my_mod.rs"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod"</span>));
|
||
<span class="macro">assert_eq!</span>(module.get_source_file_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod.rs"</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_source_file_name" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1269-1279">source</a><h4 class="code-header">pub fn <a href="#method.set_source_file_name" class="fn">set_source_file_name</a>(&self, file_name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>)</h4></section></summary><div class="docblock"><p>Sets the source file name. It defaults to the module identifier but is separate from it.</p>
|
||
<h5 id="example-27"><a class="doc-anchor" href="#example-27">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"my_mod"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_source_file_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod"</span>));
|
||
|
||
module.set_source_file_name(<span class="string">"my_mod.rs"</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(module.get_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod"</span>));
|
||
<span class="macro">assert_eq!</span>(module.get_source_file_name().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"my_mod.rs"</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.link_in_module" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1294-1324">source</a><h4 class="code-header">pub fn <a href="#method.link_in_module" class="fn">link_in_module</a>(&self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Links one module into another. This will merge two <code>Module</code>s into one.</p>
|
||
<h5 id="example-28"><a class="doc-anchor" href="#example-28">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::context::Context;
|
||
|
||
<span class="kw">let </span>context = Context::create();
|
||
<span class="kw">let </span>module = context.create_module(<span class="string">"mod"</span>);
|
||
<span class="kw">let </span>module2 = context.create_module(<span class="string">"mod2"</span>);
|
||
|
||
<span class="macro">assert!</span>(module.link_in_module(module2).is_ok());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_or_insert_comdat" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1329-1336">source</a><h4 class="code-header">pub fn <a href="#method.get_or_insert_comdat" class="fn">get_or_insert_comdat</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="struct" href="../comdat/struct.Comdat.html" title="struct inkwell::comdat::Comdat">Comdat</a></h4></section></summary><div class="docblock"><p>Gets the <code>Comdat</code> associated with a particular name. If it does not exist, it will be created.
|
||
A new <code>Comdat</code> defaults to a kind of <code>ComdatSelectionKind::Any</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_flag" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1343-1355">source</a><h4 class="code-header">pub fn <a href="#method.get_flag" class="fn">get_flag</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a><'ctx>></h4></section></summary><div class="docblock"><p>Gets the <code>MetadataValue</code> flag associated with the key in this module, if any.
|
||
If a <code>BasicValue</code> was used to create this flag, it will be wrapped in a <code>MetadataValue</code>
|
||
when returned from this function.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_metadata_flag" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1360-1372">source</a><h4 class="code-header">pub fn <a href="#method.add_metadata_flag" class="fn">add_metadata_flag</a>(
|
||
&self,
|
||
key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
behavior: <a class="enum" href="enum.FlagBehavior.html" title="enum inkwell::module::FlagBehavior">FlagBehavior</a>,
|
||
flag: <a class="struct" href="../values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a><'ctx>
|
||
)</h4></section></summary><div class="docblock"><p>Append a <code>MetadataValue</code> as a module wide flag. Note that using the same key twice
|
||
will likely invalidate the module.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_basic_value_flag" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1378-1392">source</a><h4 class="code-header">pub fn <a href="#method.add_basic_value_flag" class="fn">add_basic_value_flag</a><BV: <a class="trait" href="../values/trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a><'ctx>>(
|
||
&self,
|
||
key: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
behavior: <a class="enum" href="enum.FlagBehavior.html" title="enum inkwell::module::FlagBehavior">FlagBehavior</a>,
|
||
flag: BV
|
||
)</h4></section></summary><div class="docblock"><p>Append a <code>BasicValue</code> as a module wide flag. Note that using the same key twice
|
||
will likely invalidate the module.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.strip_debug_info" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1396-1400">source</a><h4 class="code-header">pub fn <a href="#method.strip_debug_info" class="fn">strip_debug_info</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Strips and debug info from the module, if it exists.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_debug_metadata_version" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1404-1408">source</a><h4 class="code-header">pub fn <a href="#method.get_debug_metadata_version" class="fn">get_debug_metadata_version</a>(&self) -> <a class="type" href="../../libc/unix/type.c_uint.html" title="type libc::unix::c_uint">c_uint</a></h4></section></summary><div class="docblock"><p>Gets the version of debug metadata contained in this <code>Module</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.create_debug_info_builder" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1412-1488">source</a><h4 class="code-header">pub fn <a href="#method.create_debug_info_builder" class="fn">create_debug_info_builder</a>(
|
||
&self,
|
||
allow_unresolved: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>,
|
||
language: <a class="enum" href="../debug_info/enum.DWARFSourceLanguage.html" title="enum inkwell::debug_info::DWARFSourceLanguage">DWARFSourceLanguage</a>,
|
||
filename: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
directory: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
producer: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
is_optimized: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>,
|
||
flags: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
runtime_ver: <a class="type" href="../../libc/unix/type.c_uint.html" title="type libc::unix::c_uint">c_uint</a>,
|
||
split_name: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
kind: <a class="enum" href="../debug_info/enum.DWARFEmissionKind.html" title="enum inkwell::debug_info::DWARFEmissionKind">DWARFEmissionKind</a>,
|
||
dwo_id: <a class="type" href="../../libc/unix/type.c_uint.html" title="type libc::unix::c_uint">c_uint</a>,
|
||
split_debug_inlining: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>,
|
||
debug_info_for_profiling: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a>,
|
||
sysroot: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
sdk: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>
|
||
) -> (<a class="struct" href="../debug_info/struct.DebugInfoBuilder.html" title="struct inkwell::debug_info::DebugInfoBuilder">DebugInfoBuilder</a><'ctx>, <a class="struct" href="../debug_info/struct.DICompileUnit.html" title="struct inkwell::debug_info::DICompileUnit">DICompileUnit</a><'ctx>)</h4></section></summary><div class="docblock"><p>Creates a <code>DebugInfoBuilder</code> for this <code>Module</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.run_passes" class="method"><a class="src rightside" href="../../src/inkwell/module.rs.html#1497-1517">source</a><h4 class="code-header">pub fn <a href="#method.run_passes" class="fn">run_passes</a>(
|
||
&self,
|
||
passes: &<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>,
|
||
machine: &<a class="struct" href="../targets/struct.TargetMachine.html" title="struct inkwell::targets::TargetMachine">TargetMachine</a>,
|
||
options: <a class="struct" href="../passes/struct.PassBuilderOptions.html" title="struct inkwell::passes::PassBuilderOptions">PassBuilderOptions</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></h4></section></summary><div class="docblock"><p>Construct and run a set of passes over a module.
|
||
This function takes a string with the passes that should be used.
|
||
The format of this string is the same as opt’s -passes argument for the new pass manager.
|
||
Individual passes may be specified, separated by commas.
|
||
Full pipelines may also be invoked using default<O3> and friends.
|
||
See opt for full reference of the Passes format.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Module%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#1520-1533">source</a><a href="#impl-Clone-for-Module%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'_></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/module.rs.html#1521-1532">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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-Module%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#167">source</a><a href="#impl-Debug-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</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/module.rs.html#167">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.77.2/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.77.2/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.77.2/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-Module%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#1537-1547">source</a><a href="#impl-Drop-for-Module%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'_></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/module.rs.html#1538-1546">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.77.2/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-Module%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#167">source</a><a href="#impl-PartialEq-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</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/module.rs.html#167">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/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.77.2/src/core/cmp.rs.html#242">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PassManagerSubType-for-Module%3C'_%3E" class="impl"><a class="src rightside" href="../../src/inkwell/passes.rs.html#235-245">source</a><a href="#impl-PassManagerSubType-for-Module%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../passes/trait.PassManagerSubType.html" title="trait inkwell::passes::PassManagerSubType">PassManagerSubType</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'_></h3></section></summary><div class="impl-items"><section id="associatedtype.Input" class="associatedtype trait-impl"><a href="#associatedtype.Input" class="anchor">§</a><h4 class="code-header">type <a href="../passes/trait.PassManagerSubType.html#associatedtype.Input" class="associatedtype">Input</a> = <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.unit.html">()</a></h4></section><section id="method.create" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/passes.rs.html#238-240">source</a><a href="#method.create" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../passes/trait.PassManagerSubType.html#tymethod.create" class="fn">create</a><I: <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Self::<a class="associatedtype" href="../passes/trait.PassManagerSubType.html#associatedtype.Input" title="type inkwell::passes::PassManagerSubType::Input">Input</a>>>(_: I) -> <a class="type" href="../../llvm_sys/prelude/type.LLVMPassManagerRef.html" title="type llvm_sys::prelude::LLVMPassManagerRef">LLVMPassManagerRef</a></h4></section><section id="method.run_in_pass_manager" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/passes.rs.html#242-244">source</a><a href="#method.run_in_pass_manager" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="../passes/trait.PassManagerSubType.html#tymethod.run_in_pass_manager" class="fn">run_in_pass_manager</a>(&self, pass_manager: &<a class="struct" href="../passes/struct.PassManager.html" title="struct inkwell::passes::PassManager">PassManager</a><Self>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></div></details><section id="impl-Eq-for-Module%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#167">source</a><a href="#impl-Eq-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx></h3></section><section id="impl-StructuralPartialEq-for-Module%3C'ctx%3E" class="impl"><a class="src rightside" href="../../src/inkwell/module.rs.html#167">source</a><a href="#impl-StructuralPartialEq-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</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-RefUnwindSafe-for-Module%3C'ctx%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> !<a class="trait" href="https://doc.rust-lang.org/1.77.2/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx></h3></section><section id="impl-Send-for-Module%3C'ctx%3E" class="impl"><a href="#impl-Send-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> !<a class="trait" href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx></h3></section><section id="impl-Sync-for-Module%3C'ctx%3E" class="impl"><a href="#impl-Sync-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> !<a class="trait" href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx></h3></section><section id="impl-Unpin-for-Module%3C'ctx%3E" class="impl"><a href="#impl-Unpin-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</a><'ctx></h3></section><section id="impl-UnwindSafe-for-Module%3C'ctx%3E" class="impl"><a href="#impl-UnwindSafe-for-Module%3C'ctx%3E" class="anchor">§</a><h3 class="code-header">impl<'ctx> <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Module.html" title="struct inkwell::module::Module">Module</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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/src/core/convert/mod.rs.html#764">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.77.2/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.77.2/src/core/convert/mod.rs.html#767">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/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.77.2/src/core/convert/mod.rs.html#747-749">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.77.2/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.77.2/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.77.2/src/core/convert/mod.rs.html#757">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/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.77.2/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.77.2/std/primitive.reference.html">&Self</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/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.77.2/src/core/convert/mod.rs.html#804-806">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.77.2/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.77.2/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-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.77.2/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.77.2/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.77.2/src/core/convert/mod.rs.html#811">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/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.77.2/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.77.2/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.2/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.77.2/src/core/convert/mod.rs.html#789-791">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.77.2/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.77.2/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" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.2/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.77.2/src/core/convert/mod.rs.html#796">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.77.2/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.77.2/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.77.2/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><script type="text/json" id="notable-traits-data">{"FunctionIterator<'ctx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.FunctionIterator.html\" title=\"struct inkwell::module::FunctionIterator\">FunctionIterator</a><'ctx></code></h3><pre><code><div class=\"where\">impl<'ctx> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.FunctionIterator.html\" title=\"struct inkwell::module::FunctionIterator\">FunctionIterator</a><'ctx></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"struct\" href=\"../values/struct.FunctionValue.html\" title=\"struct inkwell::values::FunctionValue\">FunctionValue</a><'ctx>;</div>","GlobalIterator<'ctx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.GlobalIterator.html\" title=\"struct inkwell::module::GlobalIterator\">GlobalIterator</a><'ctx></code></h3><pre><code><div class=\"where\">impl<'ctx> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.GlobalIterator.html\" title=\"struct inkwell::module::GlobalIterator\">GlobalIterator</a><'ctx></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"struct\" href=\"../values/struct.GlobalValue.html\" title=\"struct inkwell::values::GlobalValue\">GlobalValue</a><'ctx>;</div>"}</script></section></div></main></body></html> |