2017-07-14 23:24:09 +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" >
2017-07-14 23:30:16 +00:00
< meta name = "description" content = "API documentation for the Rust `demangle` fn in crate `rustc_demangle`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, demangle" >
2017-07-14 23:24:09 +00:00
2017-07-14 23:30:16 +00:00
< title > rustc_demangle::demangle - Rust< / title >
2017-07-14 23:24:09 +00:00
< link rel = "stylesheet" type = "text/css" href = "../normalize.css" >
< link rel = "stylesheet" type = "text/css" href = "../rustdoc.css" >
< link rel = "stylesheet" type = "text/css" href = "../main.css" >
< / head >
2017-07-14 23:30:16 +00:00
< body class = "rustdoc fn" >
2017-07-14 23:24:09 +00:00
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
2017-07-14 23:30:16 +00:00
< p class = 'location' > < a href = 'index.html' > rustc_demangle< / a > < / p > < script > window . sidebarCurrent = { name : 'demangle' , ty : 'fn' , relpath : '' } ; < / script > < script defer src = "sidebar-items.js" > < / script >
2017-07-14 23:24:09 +00:00
< / nav >
< nav class = "sub" >
< form class = "search-form js-only" >
< div class = "search-container" >
< input class = "search-input" name = "search"
autocomplete="off"
placeholder="Click or press ‘ ’ ‘ ’
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content" >
2017-07-14 23:30:16 +00:00
< h1 class = 'fqn' > < span class = 'in-band' > Function < a href = 'index.html' > rustc_demangle< / a > ::< wbr > < a class = "fn" href = '' > demangle< / a > < / span > < span class = 'out-of-band' > < span id = 'render-detail' >
2017-07-14 23:24:09 +00:00
< a id = "toggle-all-docs" href = "javascript:void(0)" title = "collapse all docs" >
[< span class = 'inner' > − < / span > ]
< / a >
2017-07-14 23:30:16 +00:00
< / span > < a class = 'srclink' href = '../src/rustc_demangle/lib.rs.html#83-128' title = 'goto source code' > [src]< / a > < / span > < / h1 >
< pre class = 'rust fn' > pub fn demangle(s: & str) -> < a class = "struct" href = "../rustc_demangle/struct.Demangle.html" title = "struct rustc_demangle::Demangle" > Demangle< / a > < / pre > < div class = 'docblock' > < p > De-mangles a Rust symbol into a more readable version< / p >
< p > All rust symbols by default are mangled as they contain characters that
cannot be represented in all object files. The mangling mechanism is similar
to C++' s, but Rust has a few specifics to handle items like lifetimes in
symbols.< / p >
< p > This function will take a < strong > mangled< / strong > symbol (typically acquired from a
< code > Symbol< / code > which is in turn resolved from a < code > Frame< / code > ) and then writes the
de-mangled version into the given < code > writer< / code > . If the symbol does not look like
a mangled symbol, it is still written to < code > writer< / code > .< / p >
< h1 id = 'examples' class = 'section-header' > < a href = '#examples' > Examples< / a > < / h1 >
< pre class = "rust rust-example-rendered" >
< span class = "kw" > use< / span > < span class = "ident" > rustc_demangle< / span > ::< span class = "ident" > demangle< / span > ;
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > demangle< / span > (< span class = "string" > " _ZN4testE" < / span > ).< span class = "ident" > to_string< / span > (), < span class = "string" > " test" < / span > );
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > demangle< / span > (< span class = "string" > " _ZN3foo3barE" < / span > ).< span class = "ident" > to_string< / span > (), < span class = "string" > " foo::bar" < / span > );
< span class = "macro" > assert_eq< / span > < span class = "macro" > !< / span > (< span class = "ident" > demangle< / span > (< span class = "string" > " foo" < / span > ).< span class = "ident" > to_string< / span > (), < span class = "string" > " foo" < / span > );< / pre >
2017-07-14 23:24:09 +00:00
< / 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 > ?< / dt >
< dd > Show this help dialog< / dd >
< dt > S< / dt >
< dd > Focus the search field< / dd >
< dt > ⇤ < / dt >
< dd > Move up in search results< / dd >
< dt > ⇥ < / dt >
< dd > Move down in search results< / dd >
< dt > ⏎ < / dt >
< dd > Go to active search result< / dd >
< dt > +< / dt >
< dd > Collapse/expand 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 >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../";
2017-07-14 23:30:16 +00:00
window.currentCrate = "rustc_demangle";
2017-07-14 23:24:09 +00:00
< / script >
< script src = "../main.js" > < / script >
< script defer src = "../search-index.js" > < / script >
< / body >
< / html >
