hasufell/pnmixer-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ba37edf785
pnmixer-rust/backtrace/fn.trace.html

144 lines
5.9 KiB
HTML
Raw Normal View History

Initial gh-pages commit
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">
Update and fix
2017-07-14 23:30:16 +00:00
<meta name="description" content="API documentation for the Rust `trace` fn in crate `backtrace`.">
<meta name="keywords" content="rust, rustlang, rust-lang, trace">
Initial gh-pages commit
2017-07-14 23:24:09 +00:00
Update and fix
2017-07-14 23:30:16 +00:00
<title>backtrace::trace - Rust</title>
Initial gh-pages commit
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>
Update and fix
2017-07-14 23:30:16 +00:00
<body class="rustdoc fn">
Initial gh-pages commit
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">
Update and fix
2017-07-14 23:30:16 +00:00
<p class='location'><a href='index.html'>backtrace</a></p><script>window.sidebarCurrent = {name: 'trace', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
Initial gh-pages commit
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 ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
Update and fix
2017-07-14 23:30:16 +00:00
<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>backtrace</a>::<wbr><a class="fn" href=''>trace</a></span><span class='out-of-band'><span id='render-detail'>
Initial gh-pages commit
2017-07-14 23:24:09 +00:00
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
Update and fix
2017-07-14 23:30:16 +00:00
</span><a class='srclink' href='../src/backtrace/backtrace/mod.rs.html#41-43' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub fn trace&lt;F:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&amp;<a class="struct" href="../backtrace/struct.Frame.html" title="struct backtrace::Frame">Frame</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;(cb: F)</pre><div class='docblock'><p>Inspects the current call-stack, passing all active frames into the closure
provided to calculate a stack trace.</p>
<p>This function is the workhorse of this library in calculating the stack
traces for a program. The given closure <code>cb</code> is yielded instances of a
<code>Frame</code> which represent information about that call frame on the stack. The
closure is yielded frames in a top-down fashion (most recently called
functions first).</p>
<p>The closure&#39;s return value is an indication of whether the backtrace should
continue. A return value of <code>false</code> will terminate the backtrace and return
immediately.</p>
<p>Once a <code>Frame</code> is acquired you will likely want to call <code>backtrace::resolve</code>
to convert the <code>ip</code> (instruction pointer) or symbol address to a <code>Symbol</code>
through which the name and/or filename/line number can be learned.</p>
<p>Note that this is a relatively low-level function and if you&#39;d like to, for
example, capture a backtrace to be inspected later, then the <code>Backtrace</code>
type may be more appropriate.</p>
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
<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="comment">// ...</span>
<span class="bool-val">true</span> <span class="comment">// continue the backtrace</span>
});
Initial gh-pages commit
2017-07-14 23:24:09 +00:00
}</pre>
Update and fix
2017-07-14 23:30:16 +00:00
</div></section>
Initial gh-pages commit
2017-07-14 23:24:09 +00:00
<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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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 = "../";
Update and fix
2017-07-14 23:30:16 +00:00
window.currentCrate = "backtrace";
Initial gh-pages commit
2017-07-14 23:24:09 +00:00
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink