<!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="Source to the Rust file `/home/jule/.cargo/registry/src/github.com-1ecc6299db9ec823/backtrace-0.3.2/src/symbolize/mod.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mod.rs.html -- source</title>
<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>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</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 ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cpp_demangle"</span>))]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">marker</span>::<span class="ident">PhantomData</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">raw</span>::<span class="ident">c_void</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">path</span>::<span class="ident">Path</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>;
<span class="kw">use</span> <span class="ident">rustc_demangle</span>::{<span class="ident">try_demangle</span>, <span class="ident">Demangle</span>};
<span class="doccomment">/// Resolve an address to a symbol, passing the symbol to the specified</span>
<span class="doccomment">/// closure.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will look up the given address in areas such as the local</span>
<span class="doccomment">/// symbol table, dynamic symbol table, or DWARF debug info (depending on the</span>
<span class="doccomment">/// activated implementation) to find symbols to yield.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The closure may not be called if resolution could not be performed, and it</span>
<span class="doccomment">/// also may be called more than once in the case of inlined functions.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Symbols yielded represent the execution at the specified `addr`, returning</span>
<span class="doccomment">/// file/line pairs for that addres (if available).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// extern crate backtrace;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn main() {</span>
<span class="doccomment">/// backtrace::trace(|frame| {</span>
<span class="doccomment">/// let ip = frame.ip();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// backtrace::resolve(ip, |symbol| {</span>
<span class="doccomment">/// // ...</span>
<span class="doccomment">/// });</span>
<span class="doccomment">///</span>
<span class="doccomment">/// false // only look at the top frame</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">resolve</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="kw-2">&</span><span class="ident">Symbol</span>)<span class="op">></span>(<span class="ident">addr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span>, <span class="kw-2">mut</span> <span class="ident">cb</span>: <span class="ident">F</span>) {
<span class="ident">resolve_imp</span>(<span class="ident">addr</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">cb</span>)
}
<span class="doccomment">/// A trait representing the resolution of a symbol in a file.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This trait is yielded as a trait object to the closure given to the</span>
<span class="doccomment">/// `backtrace::resolve` function, and it is virtually dispatched as it's</span>
<span class="doccomment">/// unknown which implementation is behind it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A symbol can give contextual information about a funciton, for example the</span>
<span class="doccomment">/// name, filename, line number, precise address, etc. Not all information is</span>
<span class="doccomment">/// always available in a symbol, however, so all methods return an `Option`.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Symbol</span> {
<span class="ident">inner</span>: <span class="ident">SymbolImp</span>,
}
<span class="kw">impl</span> <span class="ident">Symbol</span> {
<span class="doccomment">/// Returns the name of this function.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned structure can be used to query various properties about the</span>
<span class="doccomment">/// symbol name:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * The `Display` implementation will print out the demangled symbol.</span>
<span class="doccomment">/// * The raw `str` value of the symbol can be accessed (if it's valid</span>
<span class="doccomment">/// utf-8).</span>
<span class="doccomment">/// * The raw bytes for the symbol name can be accessed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">name</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">SymbolName</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">name</span>()
}
<span class="doccomment">/// Returns the starting address of this function.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">addr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_void</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">addr</span>()
}
<span class="doccomment">/// Returns the file name where this function was defined.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is currently only available when libbacktrace is being used (e.g.</span>
<span class="doccomment">/// unix platforms other than OSX) and when a binary is compiled with</span>
<span class="doccomment">/// debuginfo. If neither of these conditions is met then this will likely</span>
<span class="doccomment">/// return `None`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">filename</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">Path</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">filename</span>()
}
<span class="doccomment">/// Returns the line number for where this symbol is currently executing.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This return value is typically `Some` if `filename` returns `Some`, and</span>
<span class="doccomment">/// is consequently subject to similar caveats.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">lineno</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">lineno</span>()
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Symbol</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Symbol"</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">name</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">name</span>() {
<span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"name"</span>, <span class="kw-2">&</span><span class="ident">name</span>);
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">addr</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">addr</span>() {
<span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"addr"</span>, <span class="kw-2">&</span><span class="ident">addr</span>);
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">filename</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">filename</span>() {
<span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"filename"</span>, <span class="kw-2">&</span><span class="ident">filename</span>);
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">lineno</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">lineno</span>() {
<span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"lineno"</span>, <span class="kw-2">&</span><span class="ident">lineno</span>);
}
<span class="ident">d</span>.<span class="ident">finish</span>()
}
}
<span class="macro">cfg_if</span><span class="macro">!</span> {
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cpp_demangle"</span>)]</span> {
<span class="comment">// Maybe a parsed C++ symbol, if parsing the mangled symbol as Rust</span>
<span class="comment">// failed.</span>
<span class="kw">struct</span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="prelude-ty">Option</span><span class="op"><</span>::<span class="ident">cpp_demangle</span>::<span class="ident">BorrowedSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">>></span>);
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">OptionCppSymbol</span>(::<span class="ident">cpp_demangle</span>::<span class="ident">BorrowedSymbol</span>::<span class="ident">new</span>(<span class="ident">input</span>).<span class="ident">ok</span>())
}
<span class="kw">fn</span> <span class="ident">none</span>() <span class="op">-></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">OptionCppSymbol</span>(<span class="prelude-val">None</span>)
}
}
} <span class="kw">else</span> {
<span class="comment">// Make sure to keep this zero-sized, so that the `cpp_demangle` feature</span>
<span class="comment">// has no cost when disabled.</span>
<span class="kw">struct</span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> ()<span class="op">></span>);
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">parse</span>(_: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">OptionCppSymbol</span>(<span class="ident">PhantomData</span>)
}
<span class="kw">fn</span> <span class="ident">none</span>() <span class="op">-></span> <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">OptionCppSymbol</span>(<span class="ident">PhantomData</span>)
}
}
}
}
<span class="doccomment">/// A wrapper around a symbol name to provide ergonomic accessors to the</span>
<span class="doccomment">/// demangled name, the raw bytes, the raw string, etc.</span>
<span class="comment">// Allow dead code for when the `cpp_demangle` feature is not enabled.</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">bytes</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>],
<span class="ident">demangled</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Demangle</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">>></span>,
<span class="ident">cpp_demangled</span>: <span class="ident">OptionCppSymbol</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="doccomment">/// Creates a new symbol name from the raw underlying bytes.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">bytes</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>]) <span class="op">-></span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">str_bytes</span> <span class="op">=</span> <span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="ident">bytes</span>).<span class="ident">ok</span>();
<span class="kw">let</span> <span class="ident">demangled</span> <span class="op">=</span> <span class="ident">str_bytes</span>.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">try_demangle</span>(<span class="ident">s</span>).<span class="ident">ok</span>());
<span class="kw">let</span> <span class="ident">cpp</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">demangled</span>.<span class="ident">is_none</span>() {
<span class="ident">OptionCppSymbol</span>::<span class="ident">parse</span>(<span class="ident">bytes</span>)
} <span class="kw">else</span> {
<span class="ident">OptionCppSymbol</span>::<span class="ident">none</span>()
};
<span class="ident">SymbolName</span> {
<span class="ident">bytes</span>: <span class="ident">bytes</span>,
<span class="ident">demangled</span>: <span class="ident">demangled</span>,
<span class="ident">cpp_demangled</span>: <span class="ident">cpp</span>,
}
}
<span class="doccomment">/// Returns the raw symbol name as a `str` if the symbols is valid utf-8.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">demangled</span>
.<span class="ident">as_ref</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">as_str</span>())
.<span class="ident">or_else</span>(<span class="op">||</span> {
<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="self">self</span>.<span class="ident">bytes</span>).<span class="ident">ok</span>()
})
}
<span class="doccomment">/// Returns the raw symbol name as a list of bytes</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>] {
<span class="self">self</span>.<span class="ident">bytes</span>
}
}
<span class="macro">cfg_if</span><span class="macro">!</span> {
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cpp_demangle"</span>)]</span> {
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">demangled</span> {
<span class="ident">s</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">cpp</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">cpp_demangled</span>.<span class="number">0</span> {
<span class="ident">cpp</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
} <span class="kw">else</span> {
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="self">self</span>.<span class="ident">bytes</span>).<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
}
} <span class="kw">else</span> {
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">demangled</span> {
<span class="ident">s</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
} <span class="kw">else</span> {
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="self">self</span>.<span class="ident">bytes</span>).<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
}
}
}
<span class="macro">cfg_if</span><span class="macro">!</span> {
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cpp_demangle"</span>)]</span> {
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Write</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">demangled</span> {
<span class="kw">return</span> <span class="ident">s</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
}
<span class="comment">// This may to print if the demangled symbol isn't actually</span>
<span class="comment">// valid, so handle the error here gracefully by not propagating</span>
<span class="comment">// it outwards.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">cpp</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">cpp_demangled</span>.<span class="number">0</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">new</span>();
<span class="kw">if</span> <span class="macro">write</span><span class="macro">!</span>(<span class="ident">s</span>, <span class="string">"{}"</span>, <span class="ident">cpp</span>).<span class="ident">is_ok</span>() {
<span class="kw">return</span> <span class="ident">s</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="self">self</span>.<span class="ident">bytes</span>).<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
} <span class="kw">else</span> {
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">SymbolName</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">demangled</span> {
<span class="ident">s</span>.<span class="ident">fmt</span>(<span class="ident">f</span>)
} <span class="kw">else</span> {
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="self">self</span>.<span class="ident">bytes</span>).<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
}
}
}
<span class="macro">cfg_if</span><span class="macro">!</span> {
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">windows</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"dbghelp"</span>))]</span> {
<span class="kw">mod</span> <span class="ident">dbghelp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">dbghelp</span>::<span class="ident">resolve</span> <span class="kw">as</span> <span class="ident">resolve_imp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">dbghelp</span>::<span class="ident">Symbol</span> <span class="kw">as</span> <span class="ident">SymbolImp</span>;
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"libbacktrace"</span>,
<span class="ident">unix</span>,
<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>),
<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>),
<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>)))]</span> {
<span class="kw">mod</span> <span class="ident">libbacktrace</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">libbacktrace</span>::<span class="ident">resolve</span> <span class="kw">as</span> <span class="ident">resolve_imp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">libbacktrace</span>::<span class="ident">Symbol</span> <span class="kw">as</span> <span class="ident">SymbolImp</span>;
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"coresymbolication"</span>,
<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>,
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>)))]</span> {
<span class="kw">mod</span> <span class="ident">coresymbolication</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">coresymbolication</span>::<span class="ident">resolve</span> <span class="kw">as</span> <span class="ident">resolve_imp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">coresymbolication</span>::<span class="ident">Symbol</span> <span class="kw">as</span> <span class="ident">SymbolImp</span>;
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>,
<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>),
<span class="ident">feature</span> <span class="op">=</span> <span class="string">"dladdr"</span>))]</span> {
<span class="kw">mod</span> <span class="ident">dladdr</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">dladdr</span>::<span class="ident">resolve</span> <span class="kw">as</span> <span class="ident">resolve_imp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">dladdr</span>::<span class="ident">Symbol</span> <span class="kw">as</span> <span class="ident">SymbolImp</span>;
} <span class="kw">else</span> {
<span class="kw">mod</span> <span class="ident">noop</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">noop</span>::<span class="ident">resolve</span> <span class="kw">as</span> <span class="ident">resolve_imp</span>;
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">noop</span>::<span class="ident">Symbol</span> <span class="kw">as</span> <span class="ident">SymbolImp</span>;
}
}
</pre>
</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 = "../../../";
window.currentCrate = "backtrace";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>