<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/rust-demangler/README.md - fork/rust @ master</title>
<meta name="description" content="src/tools/rust-demangler/README.md in fork/rust at master.">
<meta property="og:title" content="src/tools/rust-demangler/README.md - fork/rust @ master">
<meta property="og:description" content="src/tools/rust-demangler/README.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/rust-demangler/">rust-demangler</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.4 KiB</span><span>36 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/4e8a689a13a47ba4cffd6461c3f21e86d8ed9c59/src/tools/rust-demangler/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>rust-demangler</h1>
<p><em>Demangles rustc mangled names.</em></p>
<p><code>rust-demangler</code> supports the requirements of the <a href="https://llvm.org/docs/CommandGuide/llvm-cov.html#cmdoption-llvm-cov-show-xdemangler"><code>llvm-cov show -Xdemangler</code>
option</a>,
to perform Rust-specific symbol demangling:</p>
<blockquote>
<p><em>The demangler is expected to read a newline-separated list of symbols from
stdin and write a newline-separated list of the same length to stdout.</em></p>
</blockquote>
<p>To use <code>rust-demangler</code> with <code>llvm-cov</code> for example:</p>
<pre class="language-bash"><a-o>$</a-o><a-f> </a-f><a-pr>TARGET</a-pr><a-f>=</a-f><a-s>&quot;</a-s><a-eb>${</a-eb><a-pr>PWD</a-pr><a-eb>}</a-eb><a-s>/build/x86_64-unknown-linux-gnu&quot;</a-s>
<a-o>$</a-o><a-f> </a-f><a-s>&quot;</a-s><a-eb>${</a-eb><a-pr>TARGET</a-pr><a-eb>}</a-eb><a-s>&quot;</a-s><a-f>/llvm/bin/llvm-cov</a-f> show \
  <a-co>--Xdemangler=path/to/rust-demangler</a-co> \
  <a-co>--instr-profile=main.profdata</a-co> ./main <a-co>--show-line-counts-or-regions</a-co></pre>
<p><code>rust-demangler</code> is a Rust "extended tool", used in Rust compiler tests, and
optionally included in Rust distributions that enable coverage profiling. Symbol
demangling is implemented using the
<a href="https://crates.io/crates/rustc-demangle">rustc-demangle</a> crate.</p>
<p><em>(Note, for Rust developers, the third-party tool
<a href="https://crates.io/crates/rustfilt"><code>rustfilt</code></a> also supports <code>llvm-cov</code> symbol
demangling. <code>rustfilt</code> is a more generalized tool that searches any body of
text, using pattern matching, to find and demangle Rust symbols.)</em></p>
<h2>License</h2>
<p>Rust-demangler is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).</p>
<p>See <a href="/LICENSE-APACHE">LICENSE-APACHE</a> and <a href="/LICENSE-MIT">LICENSE-MIT</a> for details.</p>
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/rust-demangler/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># rust-demangler</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">_Demangles rustc mangled names._</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">`rust-demangler` supports the requirements of the [`llvm-cov show -Xdemangler`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">option](https://llvm.org/docs/CommandGuide/llvm-cov.html#cmdoption-llvm-cov-show-xdemangler),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">to perform Rust-specific symbol demangling:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">&gt; _The demangler is expected to read a newline-separated list of symbols from</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">&gt; stdin and write a newline-separated list of the same length to stdout._</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">To use `rust-demangler` with `llvm-cov` for example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">```shell</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">$ TARGET=&quot;${PWD}/build/x86_64-unknown-linux-gnu&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">$ &quot;${TARGET}&quot;/llvm/bin/llvm-cov show \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">  --Xdemangler=path/to/rust-demangler \</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">  --instr-profile=main.profdata ./main --show-line-counts-or-regions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">`rust-demangler` is a Rust &quot;extended tool&quot;, used in Rust compiler tests, and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">optionally included in Rust distributions that enable coverage profiling. Symbol</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">demangling is implemented using the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">[rustc-demangle](https://crates.io/crates/rustc-demangle) crate.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">_(Note, for Rust developers, the third-party tool</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">[`rustfilt`](https://crates.io/crates/rustfilt) also supports `llvm-cov` symbol</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">demangling. `rustfilt` is a more generalized tool that searches any body of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">text, using pattern matching, to find and demangle Rust symbols.)_</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">Rust-demangler is distributed under the terms of both the MIT license and the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">Apache License (Version 2.0).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">See [LICENSE-APACHE](/LICENSE-APACHE) and [LICENSE-MIT](/LICENSE-MIT) for details.</span></span></pre></div></div>
</main>
</body>
</html>
