mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-19 17:14:24 +00:00
24 lines
4.4 KiB
HTML
24 lines
4.4 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="This attribute macro allows you to decorate an enum declaration which represents an LLVM enum with versioning constraints and/or custom variant names. There are a few expectations around the LLVM and Rust enums:"><title>llvm_enum in inkwell_internals - 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_internals" 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 attr"><!--[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_internals/index.html">inkwell_internals</a><span class="version">0.9.0</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Attribute Macro <a href="index.html">inkwell_internals</a>::<wbr><a class="attr" href="#">llvm_enum</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/inkwell_internals/lib.rs.html#87-92">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>#[llvm_enum]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This attribute macro allows you to decorate an enum declaration which represents
|
||
an LLVM enum with versioning constraints and/or custom variant names. There are
|
||
a few expectations around the LLVM and Rust enums:</p>
|
||
<ul>
|
||
<li>Both enums have the same number of variants</li>
|
||
<li>The name of the LLVM variant can be derived by appending ‘LLVM’ to the Rust variant</li>
|
||
</ul>
|
||
<p>The latter can be worked around manually with <code>#[llvm_variant]</code> if desired.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="attr">#[llvm_enum(LLVMOpcode)]
|
||
</span><span class="kw">enum </span>InstructionOpcode {
|
||
Call,
|
||
<span class="attr">#[llvm_versions(<span class="number">3.8</span>..)]
|
||
</span>CatchPad,
|
||
...,
|
||
<span class="attr">#[llvm_variant(LLVMRet)]
|
||
</span>Return,
|
||
...
|
||
}</code></pre></div>
|
||
<p>The use of <code>#[llvm_variant(NAME)]</code> allows you to override the default
|
||
naming scheme by providing the variant name which the source enum maps
|
||
to. In the above example, <code>Ret</code> was deemed unnecessarily concise, so the
|
||
source variant is named <code>Return</code> and mapped manually to <code>LLVMRet</code>.</p>
|
||
</div></details></section></div></main></body></html> |