edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-10 01:58:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/inkwell/targets/struct.TargetMachine.html

105 lines
38 KiB
HTML
Raw Normal View History

deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
<!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 `TargetMachine` struct in crate `inkwell`."><title>TargetMachine in inkwell::targets - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="inkwell" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../inkwell/index.html">inkwell</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">TargetMachine</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add_analysis_passes">add_analysis_passes</a></li><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.get_cpu">get_cpu</a></li><li><a href="#method.get_default_triple">get_default_triple</a></li><li><a href="#method.get_feature_string">get_feature_string</a></li><li><a href="#method.get_host_cpu_features">get_host_cpu_features</a></li><li><a href="#method.get_host_cpu_name">get_host_cpu_name</a></li><li><a href="#method.get_target">get_target</a></li><li><a href="#method.get_target_data">get_target_data</a></li><li><a href="#method.get_triple">get_triple</a></li><li><a href="#method.new">new</a></li><li><a href="#method.normalize_triple">normalize_triple</a></li><li><a href="#method.set_asm_verbosity">set_asm_verbosity</a></li><li><a href="#method.write_to_file">write_to_file</a></li><li><a href="#method.write_to_memory_buffer">write_to_memory_buffer</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-TargetMachine">Debug</a></li><li><a href="#impl-Drop-for-TargetMachine">Drop</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Send-for-TargetMachine">!Send</a></li><li><a href="#impl-Sync-for-TargetMachine">!Sync</a></li><li><a href="#impl-Freeze-for-TargetMachine">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-TargetMachine">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-TargetMachine">Unpin</a></li><li><a href="#impl-UnwindSafe-for-TargetMachine">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href
deploy: 21eb2e9df9c5f3904055dc274dc0b174d1a504c3
2024-05-26 15:24:04 +00:00
</div></details><section id="method.get_target" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1070-1072">source</a><h4 class="code-header">pub fn <a href="#method.get_target" class="fn">get_target</a>(&amp;self) -&gt; <a class="struct" href="struct.Target.html" title="struct inkwell::targets::Target">Target</a></h4></section><section id="method.get_triple" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1074-1078">source</a><h4 class="code-header">pub fn <a href="#method.get_triple" class="fn">get_triple</a>(&amp;self) -&gt; <a class="struct" href="struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.get_default_triple" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1091-1095">source</a><h4 class="code-header">pub fn <a href="#method.get_default_triple" class="fn">get_default_triple</a>() -&gt; <a class="struct" href="struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a></h4></section></summary><div class="docblock"><p>Gets the default triple for the current system.</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::targets::TargetMachine;
<span class="kw">let </span>default_triple = TargetMachine::get_default_triple();
<span class="macro">assert_eq!</span>(default_triple.as_str().to_str(), <span class="prelude-val">Ok</span>(<span class="string">"x86_64-pc-linux-gnu"</span>));</code></pre></div>
deploy: 21eb2e9df9c5f3904055dc274dc0b174d1a504c3
2024-05-26 15:24:04 +00:00
</div></details><section id="method.normalize_triple" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1098-1104">source</a><h4 class="code-header">pub fn <a href="#method.normalize_triple" class="fn">normalize_triple</a>(triple: &amp;<a class="struct" href="struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a>) -&gt; <a class="struct" href="struct.TargetTriple.html" title="struct inkwell::targets::TargetTriple">TargetTriple</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.get_host_cpu_name" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1112-1116">source</a><h4 class="code-header">pub fn <a href="#method.get_host_cpu_name" class="fn">get_host_cpu_name</a>() -&gt; <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></h4></section></summary><div class="docblock"><p>Gets a string containing the host CPU’s name (triple).</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h5 id="example-output"><a class="doc-anchor" href="#example-output">§</a>Example Output</h5>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p><code>x86_64-pc-linux-gnu</code></p>
deploy: 21eb2e9df9c5f3904055dc274dc0b174d1a504c3
2024-05-26 15:24:04 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_host_cpu_features" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1124-1128">source</a><h4 class="code-header">pub fn <a href="#method.get_host_cpu_features" class="fn">get_host_cpu_features</a>() -&gt; <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></h4></section></summary><div class="docblock"><p>Gets a comma separated list of supported features by the host CPU.</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h5 id="example-output-1"><a class="doc-anchor" href="#example-output-1">§</a>Example Output</h5>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p><code>+sse2,+cx16,+sahf,-tbm</code></p>
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
</div></details><section id="method.get_cpu" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1130-1132">source</a><h4 class="code-header">pub fn <a href="#method.get_cpu" class="fn">get_cpu</a>(&amp;self) -&gt; <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></h4></section><section id="method.get_feature_string" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1134-1136">source</a><h4 class="code-header">pub fn <a href="#method.get_feature_string" class="fn">get_feature_string</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/1.80.0/core/ffi/c_str/struct.CStr.html" title="struct core::ffi::c_str::CStr">CStr</a></h4></section><details class="toggle method-toggle" open><summary><section id="method.get_target_data" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1139-1141">source</a><h4 class="code-header">pub fn <a href="#method.get_target_data" class="fn">get_target_data</a>(&amp;self) -&gt; <a class="struct" href="struct.TargetData.html" title="struct inkwell::targets::TargetData">TargetData</a></h4></section></summary><div class="docblock"><p>Create TargetData from this target machine</p>
</div></details><section id="method.set_asm_verbosity" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1143-1145">source</a><h4 class="code-header">pub fn <a href="#method.set_asm_verbosity" class="fn">set_asm_verbosity</a>(&amp;self, verbosity: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>)</h4></section><section id="method.add_analysis_passes" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1148-1150">source</a><h4 class="code-header">pub fn <a href="#method.add_analysis_passes" class="fn">add_analysis_passes</a>&lt;T&gt;(&amp;self, pass_manager: &amp;<a class="struct" href="../passes/struct.PassManager.html" title="struct inkwell::passes::PassManager">PassManager</a>&lt;T&gt;)</h4></section><details class="toggle method-toggle" open><summary><section id="method.write_to_memory_buffer" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1186-1209">source</a><h4 class="code-header">pub fn <a href="#method.write_to_memory_buffer" class="fn">write_to_memory_buffer</a>(
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
&amp;self,
module: &amp;<a class="struct" href="../module/struct.Module.html" title="struct inkwell::module::Module">Module</a>&lt;'_&gt;,
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
file_type: <a class="enum" href="enum.FileType.html" title="enum inkwell::targets::FileType">FileType</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../memory_buffer/struct.MemoryBuffer.html" title="struct inkwell::memory_buffer::MemoryBuffer">MemoryBuffer</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>&gt;</h4></section></summary><div class="docblock"><p>Writes a <code>TargetMachine</code> to a <code>MemoryBuffer</code>.</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::OptimizationLevel;
<span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::targets::{CodeModel, RelocMode, FileType, Target, TargetMachine, TargetTriple, InitializationConfig};
Target::initialize_x86(<span class="kw-2">&amp;</span>InitializationConfig::default());
<span class="kw">let </span>opt = OptimizationLevel::Default;
<span class="kw">let </span>reloc = RelocMode::Default;
<span class="kw">let </span>model = CodeModel::Default;
<span class="kw">let </span>target = Target::from_name(<span class="string">"x86-64"</span>).unwrap();
<span class="kw">let </span>target_machine = target.create_target_machine(
<span class="kw-2">&amp;</span>TargetTriple::create(<span class="string">"x86_64-pc-linux-gnu"</span>),
<span class="string">"x86-64"</span>,
<span class="string">"+avx2"</span>,
opt,
reloc,
model
)
.unwrap();
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="kw">let </span>buffer = target_machine.write_to_memory_buffer(<span class="kw-2">&amp;</span>module, FileType::Assembly).unwrap();</code></pre></div>
deploy: 21eb2e9df9c5f3904055dc274dc0b174d1a504c3
2024-05-26 15:24:04 +00:00
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_to_file" class="method"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1248-1274">source</a><h4 class="code-header">pub fn <a href="#method.write_to_file" class="fn">write_to_file</a>(
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
&amp;self,
module: &amp;<a class="struct" href="../module/struct.Module.html" title="struct inkwell::module::Module">Module</a>&lt;'_&gt;,
file_type: <a class="enum" href="enum.FileType.html" title="enum inkwell::targets::FileType">FileType</a>,
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
path: &amp;<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="../support/struct.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a>&gt;</h4></section></summary><div class="docblock"><p>Saves a <code>TargetMachine</code> to a file.</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>inkwell::OptimizationLevel;
<span class="kw">use </span>inkwell::context::Context;
<span class="kw">use </span>inkwell::targets::{CodeModel, RelocMode, FileType, Target, TargetMachine, TargetTriple, InitializationConfig};
<span class="kw">use </span>std::path::Path;
Target::initialize_x86(<span class="kw-2">&amp;</span>InitializationConfig::default());
<span class="kw">let </span>opt = OptimizationLevel::Default;
<span class="kw">let </span>reloc = RelocMode::Default;
<span class="kw">let </span>model = CodeModel::Default;
<span class="kw">let </span>path = Path::new(<span class="string">"/tmp/some/path/main.asm"</span>);
<span class="kw">let </span>target = Target::from_name(<span class="string">"x86-64"</span>).unwrap();
<span class="kw">let </span>target_machine = target.create_target_machine(
<span class="kw-2">&amp;</span>TargetTriple::create(<span class="string">"x86_64-pc-linux-gnu"</span>),
<span class="string">"x86-64"</span>,
<span class="string">"+avx2"</span>,
opt,
reloc,
model
)
.unwrap();
<span class="kw">let </span>context = Context::create();
<span class="kw">let </span>module = context.create_module(<span class="string">"my_module"</span>);
<span class="kw">let </span>void_type = context.void_type();
<span class="kw">let </span>fn_type = void_type.fn_type(<span class="kw-2">&amp;</span>[], <span class="bool-val">false</span>);
module.add_function(<span class="string">"my_fn"</span>, fn_type, <span class="prelude-val">None</span>);
<span class="macro">assert!</span>(target_machine.write_to_file(<span class="kw-2">&amp;</span>module, FileType::Object, <span class="kw-2">&amp;</span>path).is_ok());</code></pre></div>
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-TargetMachine" class="impl"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1053">source</a><a href="#impl-Debug-for-TargetMachine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.TargetMachine.html" title="struct inkwell::targets::TargetMachine">TargetMachine</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1053">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.80.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-TargetMachine" class="impl"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1277-1281">source</a><a href="#impl-Drop-for-TargetMachine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.TargetMachine.html" title="struct inkwell::targets::TargetMachine">TargetMachine</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/inkwell/targets.rs.html#1278-1280">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&amp;mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.80.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-TargetMachine" class="impl"><a href="#impl-Freeze-for-TargetMachine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.TargetMachine.html" title="struct inkwell::targets::TargetMachine">TargetMachine</a></h3></section><section id="impl-RefUnwindSafe-for-TargetMachine" class="impl"><a href="#impl-RefUnwindSafe-for-TargetMachine" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.TargetMachine.html" title="struct inkwell::targets::TargetMachine">TargetMachine</a></h3></section><section id="impl-Send-for-TargetMachine" class="impl"><a href="#impl-Send-for-TargetMachine" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" h
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<p>That is, this conversion is whatever the implementation of
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
<code><a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoEither-for-T" class="impl"><a class="src rightside" href="../../src/either/into_either.rs.html#64">source</a><a href="#impl-IntoEither-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../either/into_either/trait.IntoEither.html" title="trait either::into_either::IntoEither">IntoEither</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_either" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#29">source</a><a href="#method.into_either" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either" class="fn">into_either</a>(self, into_left: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;Self, Self&gt;</h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Left</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
deploy: c568cd4876f87c92ab3102b3735a83cf3fe832f2
2024-04-13 08:42:00 +00:00
if <code>into_left</code> is <code>true</code>.
Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Right</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.into_either_with" class="method trait-impl"><a class="src rightside" href="../../src/either/into_either.rs.html#55-57">source</a><a href="#method.into_either_with" class="anchor">§</a><h4 class="code-header">fn <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with" class="fn">into_either_with</a>&lt;F&gt;(self, into_left: F) -&gt; <a class="enum" href="../../either/enum.Either.html" title="enum either::Either">Either</a>&lt;Self, Self&gt;<div class="where">where
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
F: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Self</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class='docblock'>Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Left</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
deploy: c568cd4876f87c92ab3102b3735a83cf3fe832f2
2024-04-13 08:42:00 +00:00
if <code>into_left(&amp;self)</code> returns <code>true</code>.
Converts <code>self</code> into a <a href="../../either/enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Right</code></a> variant of <a href="../../either/enum.Either.html" title="enum either::Either"><code>Either&lt;Self, Self&gt;</code></a>
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
otherwise. <a href="../../either/into_either/trait.IntoEither.html#method.into_either_with">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in a new issue Copy permalink