Trang chủ Khám phá Trợ giúp
Đăng nhập
RONCC
/
HPC-Tools-for-Quantum-Computing
Xem 1
Star 0
Fork 0
Các tập tin Các vấn đề 0 Yêu cầu khéo về 0 Wiki
Tree: e971e022d2
Branches Tags
HPC-Tools-fo...
/
doc
/
backtrace
/
struct.Backtrace.html

struct.Backtrace.html 20 KB
Lịch sử Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. <!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="API documentation for the Rust `Backtrace` struct in crate `backtrace`."><meta name="keywords" content="rust, rustlang, rust-lang, Backtrace"><title>backtrace::Backtrace - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Struct Backtrace</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_unresolved">new_unresolved</a><a href="#method.frames">frames</a><a href="#method.resolve">resolve</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-From%3CVec%3CBacktraceFrame%3E%3E">From&lt;Vec&lt;BacktraceFrame&gt;&gt;</a><a href="#impl-Into%3CVec%3CBacktraceFrame%3E%3E">Into&lt;Vec&lt;BacktraceFrame&gt;&gt;</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>backtrace</a></p><script>window.sidebarCurrent = {name: 'Backtrace', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><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"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>backtrace</a>::<wbr><a class="struct" href=''>Backtrace</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/backtrace/capture.rs.html#15-17' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Backtrace { /* fields omitted */ }</pre></div><div class='docblock'><p>Representation of an owned and self-contained backtrace.</p>
    2. 

  2. <p>This structure can be used to capture a backtrace at various points in a
    3. 

  3. program and later used to inspect what the backtrace was at that time.</p>
    4. 

  4. </div>
    5. 

  5.                     <h2 id='methods' class='small-section-header'>
    6. 

  6.                       Methods<a href='#methods' class='anchor'></a>
    7. 

  7.                     </h2>
    8. 

  8.                 <h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#46-128' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#62-66' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Captures a backtrace at the callsite of this function, returning an
    9. 

  9. owned representation.</p>
    10. 

  10. <p>This function is useful for representing a backtrace as an object in
    11. 

  11. Rust. This returned value can be sent across threads and printed
    12. 

  12. elsewhere, and the purpose of this value is to be entirely self
    13. 

  13. contained.</p>
    14. 

  14. <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
    15. 

  15. <pre class="rust rust-example-rendered">
    16. 

  16. <span class="kw">use</span> <span class="ident">backtrace</span>::<span class="ident">Backtrace</span>;
    17. 

  17. 

  18. <span class="kw">let</span> <span class="ident">current_backtrace</span> <span class="op">=</span> <span class="ident">Backtrace</span>::<span class="ident">new</span>();</pre>
    19. 

  19. </div><h4 id='method.new_unresolved' class="method"><span id='new_unresolved.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new_unresolved' class='fnname'>new_unresolved</a>() -&gt; <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#86-98' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Similar to <code>new</code> except that this does not resolve any symbols, this
    20. 

  20. simply captures the backtrace as a list of addresses.</p>
    21. 

  21. <p>At a later time the <code>resolve</code> function can be called to resolve this
    22. 

  22. backtrace's symbols into readable names. This function exists because
    23. 

  23. the resolution process can sometimes take a significant amount of time
    24. 

  24. whereas any one backtrace may only be rarely printed.</p>
    25. 

  25. <h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
    26. 

  26. <pre class="rust rust-example-rendered">
    27. 

  27. <span class="kw">use</span> <span class="ident">backtrace</span>::<span class="ident">Backtrace</span>;
    28. 

  28. 

  29. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">current_backtrace</span> <span class="op">=</span> <span class="ident">Backtrace</span>::<span class="ident">new_unresolved</span>();
    30. 

  30. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">current_backtrace</span>); <span class="comment">// no symbol names</span>
    31. 

  31. <span class="ident">current_backtrace</span>.<span class="ident">resolve</span>();
    32. 

  32. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">current_backtrace</span>); <span class="comment">// symbol names now present</span></pre>
    33. 

  33. </div><h4 id='method.frames' class="method"><span id='frames.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.frames' class='fnname'>frames</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../backtrace/struct.BacktraceFrame.html" title="struct backtrace::BacktraceFrame">BacktraceFrame</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#105-107' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the frames from when this backtrace was captured.</p>
    34. 

  34. <p>The first entry of this slice is likely the function <code>Backtrace::new</code>,
    35. 

  35. and the last frame is likely something about how this thread or the main
    36. 

  36. function started.</p>
    37. 

  37. </div><h4 id='method.resolve' class="method"><span id='resolve.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.resolve' class='fnname'>resolve</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#114-127' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>If this backtrace was created from <code>new_unresolved</code> then this function
    38. 

  38. will resolve all addresses in the backtrace to their symbolic names.</p>
    39. 

  39. <p>If this backtrace has been previously resolved or was created through
    40. 

  40. <code>new</code>, this function does nothing.</p>
    41. 

  41. </div></div>
    42. 

  42.                 <h2 id='implementations' class='small-section-header'>
    43. 

  43.                   Trait Implementations<a href='#implementations' class='anchor'></a>
    44. 

  44.                 </h2>
    45. 

  45.                 <div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#12' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#12' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
    46. 

  46. </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
    47. 

  47. </div></div><h3 id='impl-From%3CVec%3CBacktraceFrame%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../backtrace/struct.BacktraceFrame.html" title="struct backtrace::BacktraceFrame">BacktraceFrame</a>&gt;&gt; for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-From%3CVec%3CBacktraceFrame%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#130-136' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(frames: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../backtrace/struct.BacktraceFrame.html" title="struct backtrace::BacktraceFrame">BacktraceFrame</a>&gt;) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#131-135' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
    48. 

  48. </div></div><h3 id='impl-Into%3CVec%3CBacktraceFrame%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../backtrace/struct.BacktraceFrame.html" title="struct backtrace::BacktraceFrame">BacktraceFrame</a>&gt;&gt; for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Into%3CVec%3CBacktraceFrame%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#138-142' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../backtrace/struct.BacktraceFrame.html" title="struct backtrace::BacktraceFrame">BacktraceFrame</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#139-141' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
    49. 

  49. </div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#191-231' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, fmt: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#192-230' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
    50. 

  50. </div></div><h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#233-237' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#234-236' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
    51. 

  51. </div></div></div>
    52. 

  52.                 <h2 id='synthetic-implementations' class='small-section-header'>
    53. 

  53.                   Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
    54. 

  54.                 </h2>
    55. 

  55.                 <div id='synthetic-implementations-list'>
    56. 

  56.             <h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../backtrace/struct.Backtrace.html" title="struct backtrace::Backtrace">Backtrace</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "backtrace";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
    57.