mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
22 lines
6.9 KiB
HTML
22 lines
6.9 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="Demangle Rust compiler symbol names."><title>rustc_demangle - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rustc_demangle" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rustc_demangle/index.html">rustc_demangle</a><span class="version">0.1.23</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../rustc_demangle/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">rustc_demangle</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/rustc_demangle/lib.rs.html#1-588">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Demangle Rust compiler symbol names.</p>
|
||
<p>This crate provides a <code>demangle</code> function which will return a <code>Demangle</code>
|
||
sentinel value that can be used to learn about the demangled version of a
|
||
symbol name. The demangled representation will be the same as the original
|
||
if it doesn’t look like a mangled symbol name.</p>
|
||
<p><code>Demangle</code> can be formatted with the <code>Display</code> trait. The alternate
|
||
modifier (<code>#</code>) can be used to format the symbol name without the
|
||
trailing hash value.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rustc_demangle::demangle;
|
||
|
||
<span class="macro">assert_eq!</span>(demangle(<span class="string">"_ZN4testE"</span>).to_string(), <span class="string">"test"</span>);
|
||
<span class="macro">assert_eq!</span>(demangle(<span class="string">"_ZN3foo3barE"</span>).to_string(), <span class="string">"foo::bar"</span>);
|
||
<span class="macro">assert_eq!</span>(demangle(<span class="string">"foo"</span>).to_string(), <span class="string">"foo"</span>);
|
||
<span class="comment">// With hash
|
||
</span><span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{}"</span>, demangle(<span class="string">"_ZN3foo17h05af221e174051e9E"</span>)), <span class="string">"foo::h05af221e174051e9"</span>);
|
||
<span class="comment">// Without hash
|
||
</span><span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:#}"</span>, demangle(<span class="string">"_ZN3foo17h05af221e174051e9E"</span>)), <span class="string">"foo"</span>);</code></pre></div>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Demangle.html" title="struct rustc_demangle::Demangle">Demangle</a></div><div class="desc docblock-short">Representation of a demangled symbol name.</div></li><li><div class="item-name"><a class="struct" href="struct.TryDemangleError.html" title="struct rustc_demangle::TryDemangleError">TryDemangleError</a></div><div class="desc docblock-short">Error returned from the <code>try_demangle</code> function below when demangling fails.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.demangle.html" title="fn rustc_demangle::demangle">demangle</a></div><div class="desc docblock-short">De-mangles a Rust symbol into a more readable version</div></li><li><div class="item-name"><a class="fn" href="fn.try_demangle.html" title="fn rustc_demangle::try_demangle">try_demangle</a></div><div class="desc docblock-short">The same as <code>demangle</code>, except return an <code>Err</code> if the string does not appear
|
||
to be a Rust symbol, rather than “demangling” the given string as a no-op.</div></li></ul></section></div></main></body></html> |