mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-17 21:01:19 +00:00
567 lines
126 KiB
HTML
567 lines
126 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="API documentation for the Rust `Module` struct in crate `inkwell`."><meta name="keywords" content="rust, rustlang, rust-lang, Module"><title>inkwell::module::Module - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../inkwell/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Module</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.add_basic_value_flag">add_basic_value_flag</a><a href="#method.add_function">add_function</a><a href="#method.add_global">add_global</a><a href="#method.add_global_metadata">add_global_metadata</a><a href="#method.add_metadata_flag">add_metadata_flag</a><a href="#method.create">create</a><a href="#method.create_execution_engine">create_execution_engine</a><a href="#method.create_interpreter_execution_engine">create_interpreter_execution_engine</a><a href="#method.create_jit_execution_engine">create_jit_execution_engine</a><a href="#method.get_context">get_context</a><a href="#method.get_data_layout">get_data_layout</a><a href="#method.get_first_function">get_first_function</a><a href="#method.get_first_global">get_first_global</a><a href="#method.get_flag">get_flag</a><a href="#method.get_function">get_function</a><a href="#method.get_global">get_global</a><a href="#method.get_global_metadata">get_global_metadata</a><a href="#method.get_global_metadata_size">get_global_metadata_size</a><a href="#method.get_last_function">get_last_function</a><a href="#method.get_last_global">get_last_global</a><a href="#method.get_name">get_name</a><a href="#method.get_or_insert_comdat">get_or_insert_comdat</a><a href="#method.get_source_file_name">get_source_file_name</a><a href="#method.get_target">get_target</a><a href="#method.get_type">get_type</a><a href="#method.link_in_module">link_in_module</a><a href="#method.parse_bitcode_from_buffer">parse_bitcode_from_buffer</a><a href="#method.parse_bitcode_from_buffer_in_context">parse_bitcode_from_buffer_in_context</a><a href="#method.parse_bitcode_from_path">parse_bitcode_from_path</a><a href="#method.parse_bitcode_from_path_in_context">parse_bitcode_from_path_in_context</a><a href="#method.print_to_file">print_to_file</a><a href="#method.print_to_stderr">print_to_stderr</a><a href="#method.print_to_string">print_to_string</a><a href="#method.set_data_layout">set_data_layout</a><a href="#method.set_inline_assembly">set_inline_assembly</a><a href="#method.set_name">set_name</a><a href="#method.set_source_file_name">set_source_file_name</a><a href="#method.set_target">set_target</a><a href="#method.verify">verify</a><a href="#method.write_bitcode_to_file">write_bitcode_to_file</a><a href="#method.write_bitcode_to_memory">write_bitcode_to_memory</a><a href="#method.write_bitcode_to_path">write_bitcode_to_path</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq%3CModule%3E
|
||
|
|
The underlying module will be disposed when dropping this object.</p>
|
||
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#141-1405' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.create' class="method"><code id='create.v'>pub fn <a href='#method.create' class='fnname'>create</a>(name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class='srclink' href='../../src/inkwell/module.rs.html#167-175' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a named <code>Module</code>. Will be automatically assigned the global context.</p>
|
||
|
|
<p>To use your own <code>Context</code>, see <a href="../context/struct.Context.html#method.create_module">inkwell::context::create_module()</a></p>
|
||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_context</span>(), <span class="ident">context</span>);</pre></div>
|
||
|
|
</div><h4 id='method.add_function' class="method"><code id='add_function.v'>pub fn <a href='#method.add_function' class='fnname'>add_function</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> ty: <a class="struct" href="../../inkwell/types/struct.FunctionType.html" title="struct inkwell::types::FunctionType">FunctionType</a>, <br> linkage: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>><br>) -> <a class="struct" href="../../inkwell/values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#197-211' title='goto source code'>[src]</a></h4><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>
|
||
|
|
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::{<span class="ident">Module</span>, <span class="ident">Linkage</span>};
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">f32_type</span>().<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_val</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"my_function"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">fn_val</span>.<span class="ident">get_name</span>().<span class="ident">to_str</span>(), <span class="prelude-val">Ok</span>(<span class="string">"my_function"</span>));
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">fn_val</span>.<span class="ident">get_linkage</span>(), <span class="ident">Linkage</span>::<span class="ident">External</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_context' class="method"><code id='get_context.v'>pub fn <a href='#method.get_context' class='fnname'>get_context</a>(&self) -> <a class="struct" href="../../inkwell/context/struct.ContextRef.html" title="struct inkwell::context::ContextRef">ContextRef</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#231-238' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the <code>Context</code> from which this <code>Module</code> originates.</p>
|
||
|
|
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::{<span class="ident">Context</span>, <span class="ident">ContextRef</span>};
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global_context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">global_module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_global_module"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">global_module</span>.<span class="ident">get_context</span>(), <span class="ident">global_context</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">local_context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">local_module</span> <span class="op">=</span> <span class="ident">local_context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">local_module</span>.<span class="ident">get_context</span>(), <span class="ident">local_context</span>);
|
||
|
|
<span class="macro">assert_ne</span><span class="macro">!</span>(<span class="ident">local_context</span>, <span class="kw-2">*</span><span class="ident">global_context</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_first_function' class="method"><code id='get_first_function.v'>pub fn <a href='#method.get_first_function' class='fnname'>get_first_function</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#258-264' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the first <code>FunctionValue</code> defined in this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_first_function</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">void_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">void_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">void_type</span>.<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_value</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"my_fn"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">fn_value</span>, <span class="ident">module</span>.<span class="ident">get_first_function</span>().<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_last_function' class="method"><code id='get_last_function.v'>pub fn <a href='#method.get_last_function' class='fnname'>get_last_function</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#284-290' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the last <code>FunctionValue</code> defined in this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_last_function</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">void_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">void_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">void_type</span>.<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_value</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"my_fn"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">fn_value</span>, <span class="ident">module</span>.<span class="ident">get_last_function</span>().<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_function' class="method"><code id='get_function.v'>pub fn <a href='#method.get_function' class='fnname'>get_function</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.FunctionValue.html" title="struct inkwell::values::FunctionValue">FunctionValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#310-318' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets a <code>FunctionValue</code> defined in this <code>Module</code> by its name.</p>
|
||
|
|
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_function</span>(<span class="string">"my_fn"</span>).<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">void_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">void_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">void_type</span>.<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_value</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"my_fn"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">fn_value</span>, <span class="ident">module</span>.<span class="ident">get_function</span>(<span class="string">"my_fn"</span>).<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_type' class="method"><code id='get_type.v'>pub fn <a href='#method.get_type' class='fnname'>get_type</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../inkwell/types/enum.BasicTypeEnum.html" title="enum inkwell::types::BasicTypeEnum">BasicTypeEnum</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#337-349' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets a <code>BasicTypeEnum</code> of a named type in a <code>Module</code>.</p>
|
||
|
|
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_type</span>(<span class="string">"foo"</span>).<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">opaque</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">opaque_struct_type</span>(<span class="string">"foo"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_type</span>(<span class="string">"foo"</span>).<span class="ident">unwrap</span>(), <span class="ident">opaque</span>.<span class="ident">into</span>());</pre></div>
|
||
|
|
</div><h4 id='method.set_target' class="method"><code id='set_target.v'>pub fn <a href='#method.set_target' class='fnname'>set_target</a>(&self, target: &<a class="struct" href="../../inkwell/targets/struct.Target.html" title="struct inkwell::targets::Target">Target</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#371-375' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets a <code>Target</code> to this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-7" class="section-header"><a href="#example-7">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::<span class="ident">Target</span>;
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_x86</span>(<span class="kw-2">&</span><span class="ident">Default</span>::<span class="ident">default</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">target</span> <span class="op">=</span> <span class="ident">Target</span>::<span class="ident">from_name</span>(<span class="string">"x86-64"</span>).<span class="ident">unwrap</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_target</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_target</span>(<span class="kw-2">&</span><span class="ident">target</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_target</span>().<span class="ident">unwrap</span>(), <span class="ident">target</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_target' class="method"><code id='get_target.v'>pub fn <a href='#method.get_target' class='fnname'>get_target</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/targets/struct.Target.html" title="struct inkwell::targets::Target">Target</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#397-404' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the <code>Target</code> assigned to this <code>Module</code>, if any.</p>
|
||
|
|
<h1 id="example-8" class="section-header"><a href="#example-8">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::<span class="ident">Target</span>;
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_x86</span>(<span class="kw-2">&</span><span class="ident">Default</span>::<span class="ident">default</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">target</span> <span class="op">=</span> <span class="ident">Target</span>::<span class="ident">from_name</span>(<span class="string">"x86-64"</span>).<span class="ident">unwrap</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_target</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_target</span>(<span class="kw-2">&</span><span class="ident">target</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_target</span>().<span class="ident">unwrap</span>(), <span class="ident">target</span>);</pre></div>
|
||
|
|
</div><h4 id='method.create_execution_engine' class="method"><code id='create_execution_engine.v'>pub fn <a href='#method.create_execution_engine' class='fnname'>create_execution_engine</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../inkwell/execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#423-452' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates an <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-9" class="section-header"><a href="#example-9">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::{<span class="ident">InitializationConfig</span>, <span class="ident">Target</span>};
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_native</span>(<span class="kw-2">&</span><span class="ident">InitializationConfig</span>::<span class="ident">default</span>()).<span class="ident">expect</span>(<span class="string">"Failed to initialize native target"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">execution_engine</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">create_execution_engine</span>().<span class="ident">unwrap</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_context</span>(), <span class="ident">context</span>);</pre></div>
|
||
|
|
</div><h4 id='method.create_interpreter_execution_engine' class="method"><code id='create_interpreter_execution_engine.v'>pub fn <a href='#method.create_interpreter_execution_engine' class='fnname'>create_interpreter_execution_engine</a>(<br> &self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../inkwell/execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#471-501' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates an interpreter <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-10" class="section-header"><a href="#example-10">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::{<span class="ident">InitializationConfig</span>, <span class="ident">Target</span>};
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_native</span>(<span class="kw-2">&</span><span class="ident">InitializationConfig</span>::<span class="ident">default</span>()).<span class="ident">expect</span>(<span class="string">"Failed to initialize native target"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">execution_engine</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">create_interpreter_execution_engine</span>().<span class="ident">unwrap</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_context</span>(), <span class="ident">context</span>);</pre></div>
|
||
|
|
</div><h4 id='method.create_jit_execution_engine' class="method"><code id='create_jit_execution_engine.v'>pub fn <a href='#method.create_jit_execution_engine' class='fnname'>create_jit_execution_engine</a>(<br> &self, <br> opt_level: <a class="enum" href="../../inkwell/enum.OptimizationLevel.html" title="enum inkwell::OptimizationLevel">OptimizationLevel</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../inkwell/execution_engine/struct.ExecutionEngine.html" title="struct inkwell::execution_engine::ExecutionEngine">ExecutionEngine</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#521-551' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a JIT <code>ExecutionEngine</code> from this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-11" class="section-header"><a href="#example-11">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">OptimizationLevel</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::{<span class="ident">InitializationConfig</span>, <span class="ident">Target</span>};
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_native</span>(<span class="kw-2">&</span><span class="ident">InitializationConfig</span>::<span class="ident">default</span>()).<span class="ident">expect</span>(<span class="string">"Failed to initialize native target"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">get_global</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">create</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">execution_engine</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">create_jit_execution_engine</span>(<span class="ident">OptimizationLevel</span>::<span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_context</span>(), <span class="ident">context</span>);</pre></div>
|
||
|
|
</div><h4 id='method.add_global' class="method"><code id='add_global.v'>pub fn <a href='#method.add_global' class='fnname'>add_global</a><T: <a class="trait" href="../../inkwell/types/trait.BasicType.html" title="trait inkwell::types::BasicType">BasicType</a>>(<br> &self, <br> type_: T, <br> address_space: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../inkwell/enum.AddressSpace.html" title="enum inkwell::AddressSpace">AddressSpace</a>>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../inkwell/values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#569-580' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>GlobalValue</code> based on a type in an address space.</p>
|
||
|
|
<h1 id="example-12" class="section-header"><a href="#example-12">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">AddressSpace</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">i8_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">i8_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">global</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_global</span>(<span class="ident">i8_type</span>, <span class="prelude-val">Some</span>(<span class="ident">AddressSpace</span>::<span class="ident">Const</span>), <span class="string">"my_global"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_first_global</span>().<span class="ident">unwrap</span>(), <span class="ident">global</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_last_global</span>().<span class="ident">unwrap</span>(), <span class="ident">global</span>);</pre></div>
|
||
|
|
</div><h4 id='method.write_bitcode_to_path' class="method"><code id='write_bitcode_to_path.v'>pub fn <a href='#method.write_bitcode_to_path' class='fnname'>write_bitcode_to_path</a>(&self, path: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#601-608' title='goto source code'>[src]</a></h4><div class='docblock'><p>Writes a <code>Module</code> to a <code>Path</code>.</p>
|
||
|
|
<h1 id="example-13" class="section-header"><a href="#example-13">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="string">"module.bc"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">void_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">void_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">void_type</span>.<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"my_fn"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
<span class="ident">module</span>.<span class="ident">write_bitcode_to_path</span>(<span class="kw-2">&</span><span class="ident">path</span>);</pre></div>
|
||
|
|
</div><h4 id='method.write_bitcode_to_file' class="method"><code id='write_bitcode_to_file.v'>pub fn <a href='#method.write_bitcode_to_file' class='fnname'>write_bitcode_to_file</a>(<br> &self, <br> file: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>, <br> should_close: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> unbuffered: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#612-626' title='goto source code'>[src]</a></h4><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><h4 id='method.write_bitcode_to_memory' class="method"><code id='write_bitcode_to_memory.v'>pub fn <a href='#method.write_bitcode_to_memory' class='fnname'>write_bitcode_to_memory</a>(&self) -> <a class="struct" href="../../inkwell/memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#648-654' title='goto source code'>[src]</a></h4><div class='docblock'><p>Writes this <code>Module</code> to a <code>MemoryBuffer</code>.</p>
|
||
|
|
<h1 id="example-14" class="section-header"><a href="#example-14">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">void_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">void_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">fn_type</span> <span class="op">=</span> <span class="ident">void_type</span>.<span class="ident">fn_type</span>(<span class="kw-2">&</span>[], <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_function</span>(<span class="string">"f"</span>, <span class="ident">fn_type</span>, <span class="prelude-val">None</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">basic_block</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">append_basic_block</span>(<span class="string">"entry"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_builder</span>();
|
||
|
|
|
||
|
|
<span class="ident">builder</span>.<span class="ident">position_at_end</span>(<span class="kw-2">&</span><span class="ident">basic_block</span>);
|
||
|
|
<span class="ident">builder</span>.<span class="ident">build_return</span>(<span class="prelude-val">None</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">write_bitcode_to_memory</span>();</pre></div>
|
||
|
|
</div><h4 id='method.verify' class="method"><code id='verify.v'>pub fn <a href='#method.verify' class='fnname'>verify</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#661-675' title='goto source code'>[src]</a></h4><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>
|
||
|
|
<h1 id="remarks" class="section-header"><a href="#remarks">Remarks</a></h1>
|
||
|
|
<p>See also: http://llvm.org/doxygen/Analysis_2Analysis_8cpp_source.html</p>
|
||
|
|
</div><h4 id='method.get_data_layout' class="method"><code id='get_data_layout.v'>pub fn <a href='#method.get_data_layout' class='fnname'>get_data_layout</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="../../inkwell/data_layout/struct.DataLayout.html" title="struct inkwell::data_layout::DataLayout">DataLayout</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#715-717' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets a smart pointer to the <code>DataLayout</code> belonging to a particular <code>Module</code>.</p>
|
||
|
|
<h1 id="example-15" class="section-header"><a href="#example-15">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">OptimizationLevel</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::{<span class="ident">InitializationConfig</span>, <span class="ident">Target</span>};
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_native</span>(<span class="kw-2">&</span><span class="ident">InitializationConfig</span>::<span class="ident">default</span>()).<span class="ident">expect</span>(<span class="string">"Failed to initialize native target"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"sum"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">execution_engine</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">create_jit_execution_engine</span>(<span class="ident">OptimizationLevel</span>::<span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">target_data</span> <span class="op">=</span> <span class="ident">execution_engine</span>.<span class="ident">get_target_data</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">data_layout</span> <span class="op">=</span> <span class="ident">target_data</span>.<span class="ident">get_data_layout</span>();
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_data_layout</span>(<span class="kw-2">&</span><span class="ident">data_layout</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_data_layout</span>(), <span class="ident">data_layout</span>);</pre></div>
|
||
|
|
</div><h4 id='method.set_data_layout' class="method"><code id='set_data_layout.v'>pub fn <a href='#method.set_data_layout' class='fnname'>set_data_layout</a>(&self, data_layout: &<a class="struct" href="../../inkwell/data_layout/struct.DataLayout.html" title="struct inkwell::data_layout::DataLayout">DataLayout</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#742-748' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the <code>DataLayout</code> for a particular <code>Module</code>.</p>
|
||
|
|
<h1 id="example-16" class="section-header"><a href="#example-16">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">OptimizationLevel</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">targets</span>::{<span class="ident">InitializationConfig</span>, <span class="ident">Target</span>};
|
||
|
|
|
||
|
|
<span class="ident">Target</span>::<span class="ident">initialize_native</span>(<span class="kw-2">&</span><span class="ident">InitializationConfig</span>::<span class="ident">default</span>()).<span class="ident">expect</span>(<span class="string">"Failed to initialize native target"</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"sum"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">execution_engine</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">create_jit_execution_engine</span>(<span class="ident">OptimizationLevel</span>::<span class="prelude-val">None</span>).<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">target_data</span> <span class="op">=</span> <span class="ident">execution_engine</span>.<span class="ident">get_target_data</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">data_layout</span> <span class="op">=</span> <span class="ident">target_data</span>.<span class="ident">get_data_layout</span>();
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_data_layout</span>(<span class="kw-2">&</span><span class="ident">data_layout</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_data_layout</span>(), <span class="ident">data_layout</span>);</pre></div>
|
||
|
|
</div><h4 id='method.print_to_stderr' class="method"><code id='print_to_stderr.v'>pub fn <a href='#method.print_to_stderr' class='fnname'>print_to_stderr</a>(&self)</code><a class='srclink' href='../../src/inkwell/module.rs.html#751-755' title='goto source code'>[src]</a></h4><div class='docblock'><p>Prints the content of the <code>Module</code> to stderr.</p>
|
||
|
|
</div><h4 id='method.print_to_string' class="method"><code id='print_to_string.v'>pub fn <a href='#method.print_to_string' class='fnname'>print_to_string</a>(&self) -> <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#758-764' title='goto source code'>[src]</a></h4><div class='docblock'><p>Prints the content of the <code>Module</code> to a string.</p>
|
||
|
|
</div><h4 id='method.print_to_file' class="method"><code id='print_to_file.v'>pub fn <a href='#method.print_to_file' class='fnname'>print_to_file</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(&self, path: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#767-780' title='goto source code'>[src]</a></h4><div class='docblock'><p>Prints the content of the <code>Module</code> to a file.</p>
|
||
|
|
</div><h4 id='method.set_inline_assembly' class="method"><code id='set_inline_assembly.v'>pub fn <a href='#method.set_inline_assembly' class='fnname'>set_inline_assembly</a>(&self, asm: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#783-804' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the inline assembly for the <code>Module</code>.</p>
|
||
|
|
</div><h4 id='method.add_global_metadata' class="method"><code id='add_global_metadata.v'>pub fn <a href='#method.add_global_metadata' class='fnname'>add_global_metadata</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, metadata: &<a class="struct" href="../../inkwell/values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#847-853' title='goto source code'>[src]</a></h4><div class='docblock'><p>Appends a <code>MetaDataValue</code> to a global list indexed by a particular key.</p>
|
||
|
|
<h1 id="example-17" class="section-header"><a href="#example-17">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">values</span>::<span class="ident">MetadataValue</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">bool_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">f32_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_val</span> <span class="op">=</span> <span class="ident">bool_type</span>.<span class="ident">const_int</span>(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_val</span> <span class="op">=</span> <span class="ident">f32_type</span>.<span class="ident">const_float</span>(<span class="number">0.0</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">md_string</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_string</span>(<span class="string">"lots of metadata here"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">md_node</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_node</span>(<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="ident">bool_val</span>, <span class="kw-2">&</span><span class="ident">f32_val</span>]);
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_string</span>);
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_node</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global_md</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">get_global_metadata</span>(<span class="string">"my_md"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">global_md</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> (<span class="ident">md_0</span>, <span class="ident">md_1</span>) <span class="op">=</span> (<span class="ident">global_md</span>[<span class="number">0</span>].<span class="ident">get_node_values</span>(), <span class="ident">global_md</span>[<span class="number">1</span>].<span class="ident">get_node_values</span>());
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>[<span class="number">0</span>].<span class="ident">as_metadata_value</span>().<span class="ident">get_string_value</span>(), <span class="ident">md_string</span>.<span class="ident">get_string_value</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">0</span>].<span class="ident">as_int_value</span>(), <span class="kw-2">&</span><span class="ident">bool_val</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">1</span>].<span class="ident">as_float_value</span>(), <span class="kw-2">&</span><span class="ident">f32_val</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_global_metadata_size' class="method"><code id='get_global_metadata_size.v'>pub fn <a href='#method.get_global_metadata_size' class='fnname'>get_global_metadata_size</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#893-899' title='goto source code'>[src]</a></h4><div class='docblock'><p>Obtains the number of <code>MetaDataValue</code>s indexed by a particular key.</p>
|
||
|
|
<h1 id="example-18" class="section-header"><a href="#example-18">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">values</span>::<span class="ident">MetadataValue</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">bool_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">f32_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_val</span> <span class="op">=</span> <span class="ident">bool_type</span>.<span class="ident">const_int</span>(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_val</span> <span class="op">=</span> <span class="ident">f32_type</span>.<span class="ident">const_float</span>(<span class="number">0.0</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">md_string</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_string</span>(<span class="string">"lots of metadata here"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">md_node</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_node</span>(<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="ident">bool_val</span>, <span class="kw-2">&</span><span class="ident">f32_val</span>]);
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_string</span>);
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_node</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global_md</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">get_global_metadata</span>(<span class="string">"my_md"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">global_md</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> (<span class="ident">md_0</span>, <span class="ident">md_1</span>) <span class="op">=</span> (<span class="ident">global_md</span>[<span class="number">0</span>].<span class="ident">get_node_values</span>(), <span class="ident">global_md</span>[<span class="number">1</span>].<span class="ident">get_node_values</span>());
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>[<span class="number">0</span>].<span class="ident">as_metadata_value</span>().<span class="ident">get_string_value</span>(), <span class="ident">md_string</span>.<span class="ident">get_string_value</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">0</span>].<span class="ident">as_int_value</span>(), <span class="kw-2">&</span><span class="ident">bool_val</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">1</span>].<span class="ident">as_float_value</span>(), <span class="kw-2">&</span><span class="ident">f32_val</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_global_metadata' class="method"><code id='get_global_metadata.v'>pub fn <a href='#method.get_global_metadata' class='fnname'>get_global_metadata</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../inkwell/values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#939-955' title='goto source code'>[src]</a></h4><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>
|
||
|
|
<h1 id="example-19" class="section-header"><a href="#example-19">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">values</span>::<span class="ident">MetadataValue</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">bool_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">f32_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">bool_val</span> <span class="op">=</span> <span class="ident">bool_type</span>.<span class="ident">const_int</span>(<span class="number">0</span>, <span class="bool-val">false</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">f32_val</span> <span class="op">=</span> <span class="ident">f32_type</span>.<span class="ident">const_float</span>(<span class="number">0.0</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">0</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">md_string</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_string</span>(<span class="string">"lots of metadata here"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">md_node</span> <span class="op">=</span> <span class="ident">MetadataValue</span>::<span class="ident">create_node</span>(<span class="kw-2">&</span>[<span class="kw-2">&</span><span class="ident">bool_val</span>, <span class="kw-2">&</span><span class="ident">f32_val</span>]);
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_string</span>);
|
||
|
|
<span class="ident">module</span>.<span class="ident">add_global_metadata</span>(<span class="string">"my_md"</span>, <span class="kw-2">&</span><span class="ident">md_node</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global_metadata_size</span>(<span class="string">"my_md"</span>), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global_md</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">get_global_metadata</span>(<span class="string">"my_md"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">global_md</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> (<span class="ident">md_0</span>, <span class="ident">md_1</span>) <span class="op">=</span> (<span class="ident">global_md</span>[<span class="number">0</span>].<span class="ident">get_node_values</span>(), <span class="ident">global_md</span>[<span class="number">1</span>].<span class="ident">get_node_values</span>());
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_0</span>[<span class="number">0</span>].<span class="ident">as_metadata_value</span>().<span class="ident">get_string_value</span>(), <span class="ident">md_string</span>.<span class="ident">get_string_value</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">0</span>].<span class="ident">as_int_value</span>(), <span class="kw-2">&</span><span class="ident">bool_val</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">md_1</span>[<span class="number">1</span>].<span class="ident">as_float_value</span>(), <span class="kw-2">&</span><span class="ident">f32_val</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_first_global' class="method"><code id='get_first_global.v'>pub fn <a href='#method.get_first_global' class='fnname'>get_first_global</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#975-985' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the first <code>GlobalValue</code> in a module.</p>
|
||
|
|
<h1 id="example-20" class="section-header"><a href="#example-20">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">AddressSpace</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">i8_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">i8_type</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_first_global</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_global</span>(<span class="ident">i8_type</span>, <span class="prelude-val">Some</span>(<span class="ident">AddressSpace</span>::<span class="ident">Const</span>), <span class="string">"my_global"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_first_global</span>().<span class="ident">unwrap</span>(), <span class="ident">global</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_last_global' class="method"><code id='get_last_global.v'>pub fn <a href='#method.get_last_global' class='fnname'>get_last_global</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1005-1015' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the last <code>GlobalValue</code> in a module.</p>
|
||
|
|
<h1 id="example-21" class="section-header"><a href="#example-21">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">AddressSpace</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">i8_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">i8_type</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_last_global</span>().<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_global</span>(<span class="ident">i8_type</span>, <span class="prelude-val">Some</span>(<span class="ident">AddressSpace</span>::<span class="ident">Const</span>), <span class="string">"my_global"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_last_global</span>().<span class="ident">unwrap</span>(), <span class="ident">global</span>);</pre></div>
|
||
|
|
</div><h4 id='method.get_global' class="method"><code id='get_global.v'>pub fn <a href='#method.get_global' class='fnname'>get_global</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.GlobalValue.html" title="struct inkwell::values::GlobalValue">GlobalValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1035-1046' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets a named <code>GlobalValue</code> in a module.</p>
|
||
|
|
<h1 id="example-22" class="section-header"><a href="#example-22">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">AddressSpace</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">i8_type</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">i8_type</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global</span>(<span class="string">"my_global"</span>).<span class="ident">is_none</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">global</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">add_global</span>(<span class="ident">i8_type</span>, <span class="prelude-val">Some</span>(<span class="ident">AddressSpace</span>::<span class="ident">Const</span>), <span class="string">"my_global"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">get_global</span>(<span class="string">"my_global"</span>).<span class="ident">unwrap</span>(), <span class="ident">global</span>);</pre></div>
|
||
|
|
</div><h4 id='method.parse_bitcode_from_buffer' class="method"><code id='parse_bitcode_from_buffer.v'>pub fn <a href='#method.parse_bitcode_from_buffer' class='fnname'>parse_bitcode_from_buffer</a>(<br> buffer: &<a class="struct" href="../../inkwell/memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1065-1082' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new <code>Module</code> from a <code>MemoryBuffer</code>.</p>
|
||
|
|
<h1 id="example-23" class="section-header"><a href="#example-23">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">memory_buffer</span>::<span class="ident">MemoryBuffer</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="string">"foo/bar.bc"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">MemoryBuffer</span>::<span class="ident">create_from_file</span>(<span class="kw-2">&</span><span class="ident">path</span>).<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">parse_bitcode_from_buffer</span>(<span class="kw-2">&</span><span class="ident">buffer</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">unwrap</span>().<span class="ident">get_context</span>(), <span class="ident">Context</span>::<span class="ident">get_global</span>());
|
||
|
|
</pre></div>
|
||
|
|
</div><h4 id='method.parse_bitcode_from_buffer_in_context' class="method"><code id='parse_bitcode_from_buffer_in_context.v'>pub fn <a href='#method.parse_bitcode_from_buffer_in_context' class='fnname'>parse_bitcode_from_buffer_in_context</a>(<br> buffer: &<a class="struct" href="../../inkwell/memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a>, <br> context: &<a class="struct" href="../../inkwell/context/struct.Context.html" title="struct inkwell::context::Context">Context</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1102-1119' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new <code>Module</code> from a <code>MemoryBuffer</code>.</p>
|
||
|
|
<h1 id="example-24" class="section-header"><a href="#example-24">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">memory_buffer</span>::<span class="ident">MemoryBuffer</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="string">"foo/bar.bc"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">MemoryBuffer</span>::<span class="ident">create_from_file</span>(<span class="kw-2">&</span><span class="ident">path</span>).<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">parse_bitcode_from_buffer_in_context</span>(<span class="kw-2">&</span><span class="ident">buffer</span>, <span class="kw-2">&</span><span class="ident">context</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">unwrap</span>().<span class="ident">get_context</span>(), <span class="ident">Context</span>::<span class="ident">get_global</span>());
|
||
|
|
</pre></div>
|
||
|
|
</div><h4 id='method.parse_bitcode_from_path' class="method"><code id='parse_bitcode_from_path.v'>pub fn <a href='#method.parse_bitcode_from_path' class='fnname'>parse_bitcode_from_path</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> path: P<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1138-1142' title='goto source code'>[src]</a></h4><div class='docblock'><p>A convenience function for creating a <code>Module</code> from a file.</p>
|
||
|
|
<h1 id="example-25" class="section-header"><a href="#example-25">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="string">"foo/bar.bc"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">parse_bitcode_from_path</span>(<span class="kw-2">&</span><span class="ident">path</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">unwrap</span>().<span class="ident">get_context</span>(), <span class="ident">Context</span>::<span class="ident">get_global</span>());
|
||
|
|
</pre></div>
|
||
|
|
</div><h4 id='method.parse_bitcode_from_path_in_context' class="method"><code id='parse_bitcode_from_path_in_context.v'>pub fn <a href='#method.parse_bitcode_from_path_in_context' class='fnname'>parse_bitcode_from_path_in_context</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> path: P, <br> context: &<a class="struct" href="../../inkwell/context/struct.Context.html" title="struct inkwell::context::Context">Context</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1162-1166' title='goto source code'>[src]</a></h4><div class='docblock'><p>A convenience function for creating a <code>Module</code> from a file for a given context.</p>
|
||
|
|
<h1 id="example-26" class="section-header"><a href="#example-26">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">module</span>::<span class="ident">Module</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="ident">Path</span>::<span class="ident">new</span>(<span class="string">"foo/bar.bc"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">Module</span>::<span class="ident">parse_bitcode_from_path_in_context</span>(<span class="kw-2">&</span><span class="ident">path</span>, <span class="kw-2">&</span><span class="ident">context</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">unwrap</span>().<span class="ident">get_context</span>(), <span class="ident">context</span>);
|
||
|
|
</pre></div>
|
||
|
|
</div><h4 id='method.get_name' class="method"><code id='get_name.v'>pub fn <a href='#method.get_name' class='fnname'>get_name</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CStr.html" title="struct std::ffi::c_str::CStr">CStr</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#1182-1191' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the name of this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-27" class="section-header"><a href="#example-27">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mdoule"</span>).<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.set_name' class="method"><code id='set_name.v'>pub fn <a href='#method.set_name' class='fnname'>set_name</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#1209-1213' title='goto source code'>[src]</a></h4><div class='docblock'><p>Assigns the name of this <code>Module</code>.</p>
|
||
|
|
<h1 id="example-28" class="section-header"><a href="#example-28">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_module"</span>);
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_name</span>(<span class="string">"my_module2"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_module2"</span>).<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_source_file_name' class="method"><code id='get_source_file_name.v'>pub fn <a href='#method.get_source_file_name' class='fnname'>get_source_file_name</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CStr.html" title="struct std::ffi::c_str::CStr">CStr</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#1234-1245' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the source file name. It defaults to the module identifier but is separate from it.</p>
|
||
|
|
<h1 id="example-29" class="section-header"><a href="#example-29">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_source_file_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod"</span>).<span class="ident">unwrap</span>());
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_source_file_name</span>(<span class="string">"my_mod.rs"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod"</span>).<span class="ident">unwrap</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_source_file_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod.rs"</span>).<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.set_source_file_name' class="method"><code id='set_source_file_name.v'>pub fn <a href='#method.set_source_file_name' class='fnname'>set_source_file_name</a>(&self, file_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#1266-1272' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the source file name. It defaults to the module identifier but is separate from it.</p>
|
||
|
|
<h1 id="example-30" class="section-header"><a href="#example-30">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"my_mod"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_source_file_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod"</span>).<span class="ident">unwrap</span>());
|
||
|
|
|
||
|
|
<span class="ident">module</span>.<span class="ident">set_source_file_name</span>(<span class="string">"my_mod.rs"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod"</span>).<span class="ident">unwrap</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">module</span>.<span class="ident">get_source_file_name</span>(), <span class="kw-2">*</span><span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"my_mod.rs"</span>).<span class="ident">unwrap</span>());</pre></div>
|
||
|
|
</div><h4 id='method.link_in_module' class="method"><code id='link_in_module.v'>pub fn <a href='#method.link_in_module' class='fnname'>link_in_module</a>(&self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../inkwell/support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1287-1337' title='goto source code'>[src]</a></h4><div class='docblock'><p>Links one module into another. This will merge two <code>Module</code>s into one.</p>
|
||
|
|
<h1 id="example-31" class="section-header"><a href="#example-31">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">inkwell</span>::<span class="ident">context</span>::<span class="ident">Context</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">Context</span>::<span class="ident">create</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">module</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">module2</span> <span class="op">=</span> <span class="ident">context</span>.<span class="ident">create_module</span>(<span class="string">"mod2"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">module</span>.<span class="ident">link_in_module</span>(<span class="ident">module2</span>).<span class="ident">is_ok</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_or_insert_comdat' class="method"><code id='get_or_insert_comdat.v'>pub fn <a href='#method.get_or_insert_comdat' class='fnname'>get_or_insert_comdat</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../inkwell/comdat/struct.Comdat.html" title="struct inkwell::comdat::Comdat">Comdat</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#1342-1351' title='goto source code'>[src]</a></h4><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><h4 id='method.get_flag' class="method"><code id='get_flag.v'>pub fn <a href='#method.get_flag' class='fnname'>get_flag</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../inkwell/values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a>></code><a class='srclink' href='../../src/inkwell/module.rs.html#1358-1377' title='goto source code'>[src]</a></h4><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><h4 id='method.add_metadata_flag' class="method"><code id='add_metadata_flag.v'>pub fn <a href='#method.add_metadata_flag' class='fnname'>add_metadata_flag</a>(<br> &self, <br> key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> behavior: <a class="enum" href="../../inkwell/module/enum.FlagBehavior.html" title="enum inkwell::module::FlagBehavior">FlagBehavior</a>, <br> flag: <a class="struct" href="../../inkwell/values/struct.MetadataValue.html" title="struct inkwell::values::MetadataValue">MetadataValue</a><br>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#1382-1388' title='goto source code'>[src]</a></h4><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><h4 id='method.add_basic_value_flag' class="method"><code id='add_basic_value_flag.v'>pub fn <a href='#method.add_basic_value_flag' class='fnname'>add_basic_value_flag</a><BV: <a class="trait" href="../../inkwell/values/trait.BasicValue.html" title="trait inkwell::values::BasicValue">BasicValue</a>>(<br> &self, <br> key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> behavior: <a class="enum" href="../../inkwell/module/enum.FlagBehavior.html" title="enum inkwell::module::FlagBehavior">FlagBehavior</a>, <br> flag: BV<br>)</code><a class='srclink' href='../../src/inkwell/module.rs.html#1394-1404' title='goto source code'>[src]</a></h4><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></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-PassManagerSubType' class='impl'><code class='in-band'>impl <a class="trait" href="../../inkwell/passes/trait.PassManagerSubType.html" title="trait inkwell::passes::PassManagerSubType">PassManagerSubType</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-PassManagerSubType' class='anchor'></a><a class='srclink' href='../../src/inkwell/passes.rs.html#176-186' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Input' class="type"><code id='Input.t'>type <a href='../../inkwell/passes/trait.PassManagerSubType.html#associatedtype.Input' class="type">Input</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></h4><h4 id='method.create-1' class="method hidden"><code id='create.v-1'>unsafe fn <a href='../../inkwell/passes/trait.PassManagerSubType.html#tymethod.create' class='fnname'>create</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><Self::<a class="type" href="../../inkwell/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></code><a class='srclink' href='../../src/inkwell/passes.rs.html#179-181' title='goto source code'>[src]</a></h4><h4 id='method.run_in_pass_manager' class="method hidden"><code id='run_in_pass_manager.v'>unsafe fn <a href='../../inkwell/passes/trait.PassManagerSubType.html#tymethod.run_in_pass_manager' class='fnname'>run_in_pass_manager</a>(&self, pass_manager: &<a class="struct" href="../../inkwell/passes/struct.PassManager.html" title="struct inkwell::passes::PassManager">PassManager</a><Self>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/passes.rs.html#183-185' title='goto source code'>[src]</a></h4></div><h3 id='impl-Eq' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Eq' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Drop' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#1424-1434' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../src/inkwell/module.rs.html#1425-1433' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#1407-1420' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> Self</code><a class='srclink' href='../../src/inkwell/module.rs.html#1408-1419' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-PartialEq%3CModule%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a>> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-PartialEq%3CModule%3E' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
|
|
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/inkwell/module.rs.html#133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Sync' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../inkwell/module/struct.Module.html" title="struct inkwell::module::Module">Module</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#552-554' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "inkwell";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|