mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
73 lines
12 KiB
HTML
73 lines
12 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="API documentation for the Rust `backtrace` crate."><meta name="keywords" content="rust, rustlang, rust-lang, backtrace"><title>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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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">☰</div><a href='../backtrace/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate backtrace</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all backtrace's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'backtrace', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/backtrace/lib.rs.html#1-153' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>backtrace</a></span></h1><div class='docblock'><p>A library for acquiring a backtrace at runtime</p>
|
||
<p>This library is meant to supplement the <code>RUST_BACKTRACE=1</code> support of the
|
||
standard library by allowing an acquisition of a backtrace at runtime
|
||
programmatically. The backtraces generated by this library do not need to be
|
||
parsed, for example, and expose the functionality of multiple backend
|
||
implementations.</p>
|
||
<h1 id="implementation" class="section-header"><a href="#implementation">Implementation</a></h1>
|
||
<p>This library makes use of a number of strategies for actually acquiring a
|
||
backtrace. For example unix uses libgcc's libunwind bindings by default to
|
||
acquire a backtrace, but coresymbolication or dladdr is used on OSX to
|
||
acquire symbol names while linux uses gcc's libbacktrace.</p>
|
||
<p>When using the default feature set of this library the "most reasonable" set
|
||
of defaults is chosen for the current platform, but the features activated
|
||
can also be controlled at a finer granularity.</p>
|
||
<h1 id="api-principles" class="section-header"><a href="#api-principles">API Principles</a></h1>
|
||
<p>This library attempts to be as flexible as possible to accommodate different
|
||
backend implementations of acquiring a backtrace. Consequently the currently
|
||
exported functions are closure-based as opposed to the likely expected
|
||
iterator-based versions. This is done due to limitations of the underlying
|
||
APIs used from the system.</p>
|
||
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
||
<p>First, add this to your Cargo.toml</p>
|
||
<pre><code class="language-toml">[dependencies]
|
||
backtrace = "0.3"
|
||
</code></pre>
|
||
<p>Next:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">backtrace</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="ident">backtrace</span>::<span class="ident">trace</span>(<span class="op">|</span><span class="ident">frame</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="ident">ip</span> <span class="op">=</span> <span class="ident">frame</span>.<span class="ident">ip</span>();
|
||
<span class="kw">let</span> <span class="ident">symbol_address</span> <span class="op">=</span> <span class="ident">frame</span>.<span class="ident">symbol_address</span>();
|
||
|
||
<span class="comment">// Resolve this instruction pointer to a symbol name</span>
|
||
<span class="ident">backtrace</span>::<span class="ident">resolve_frame</span>(<span class="ident">frame</span>, <span class="op">|</span><span class="ident">symbol</span><span class="op">|</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="ident">symbol</span>.<span class="ident">name</span>() {
|
||
<span class="comment">// ...</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="ident">symbol</span>.<span class="ident">filename</span>() {
|
||
<span class="comment">// ...</span>
|
||
}
|
||
});
|
||
|
||
<span class="bool-val">true</span> <span class="comment">// keep going to the next frame</span>
|
||
});
|
||
}</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Backtrace.html" title='backtrace::Backtrace struct'>Backtrace</a></td><td class='docblock-short'><p>Representation of an owned and self-contained backtrace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.BacktraceFrame.html" title='backtrace::BacktraceFrame struct'>BacktraceFrame</a></td><td class='docblock-short'><p>Captured version of a frame in a backtrace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.BacktraceSymbol.html" title='backtrace::BacktraceSymbol struct'>BacktraceSymbol</a></td><td class='docblock-short'><p>Captured version of a symbol in a backtrace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Frame.html" title='backtrace::Frame struct'>Frame</a></td><td class='docblock-short'><p>A trait representing one frame of a backtrace, yielded to the <code>trace</code>
|
||
function of this crate.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Symbol.html" title='backtrace::Symbol struct'>Symbol</a></td><td class='docblock-short'><p>A trait representing the resolution of a symbol in a file.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SymbolName.html" title='backtrace::SymbolName struct'>SymbolName</a></td><td class='docblock-short'><p>A wrapper around a symbol name to provide ergonomic accessors to the
|
||
demangled name, the raw bytes, the raw string, etc.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.BytesOrWideString.html" title='backtrace::BytesOrWideString enum'>BytesOrWideString</a></td><td class='docblock-short'><p>A platform independent representation of a string. When working with <code>std</code>
|
||
enabled it is recommended to the convenience methods for providing
|
||
conversions to <code>std</code> types.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.clear_symbol_cache.html" title='backtrace::clear_symbol_cache fn'>clear_symbol_cache</a></td><td class='docblock-short'><p>Attempt to reclaim that cached memory used to symbolicate addresses.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resolve.html" title='backtrace::resolve fn'>resolve</a></td><td class='docblock-short'><p>Resolve an address to a symbol, passing the symbol to the specified
|
||
closure.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resolve_frame.html" title='backtrace::resolve_frame fn'>resolve_frame</a></td><td class='docblock-short'><p>Resolve a previously capture frame to a symbol, passing the symbol to the
|
||
specified closure.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resolve_frame_unsynchronized.html" title='backtrace::resolve_frame_unsynchronized fn'>resolve_frame_unsynchronized</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Same as <code>resolve_frame</code>, only unsafe as it's unsynchronized.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resolve_unsynchronized.html" title='backtrace::resolve_unsynchronized fn'>resolve_unsynchronized</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Same as <code>resolve</code>, only unsafe as it's unsynchronized.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.trace.html" title='backtrace::trace fn'>trace</a></td><td class='docblock-short'><p>Inspects the current call-stack, passing all active frames into the closure
|
||
provided to calculate a stack trace.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.trace_unsynchronized.html" title='backtrace::trace_unsynchronized fn'>trace_unsynchronized</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Same as <code>trace</code>, only unsafe as it's unsynchronized.</p>
|
||
</td></tr></table></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>⏎</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> |