151 lines
12 KiB
HTML
151 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` struct in crate `error_chain`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Backtrace">
|
||
|
||
<title>error_chain::Backtrace - Rust</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 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">
|
||
|
||
<p class='location'>Struct Backtrace</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>error_chain</a></p><script>window.sidebarCurrent = {name: 'Backtrace', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</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">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>error_chain</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/backtrace/capture.rs.html#15-17' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Backtrace { /* fields omitted */ }</pre><div class='docblock'><p>Representation of an owned and self-contained backtrace.</p>
|
||
|
||
<p>This structure can be used to capture a backtrace at various points in a
|
||
program and later used to inspect what the backtrace was at that time.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#46-93' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span></h4>
|
||
<div class='docblock'><p>Captures a backtrace at the callsite of this function, returning an
|
||
owned representation.</p>
|
||
|
||
<p>This function is useful for representing a backtrace as an object in
|
||
Rust. This returned value can be sent across threads and printed
|
||
elsewhere, and thie purpose of this value is to be entirely self
|
||
contained.</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">backtrace</span>::<span class="ident">Backtrace</span>;
|
||
|
||
<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>
|
||
</div><h4 id='method.frames' class="method"><span id='frames.v' class='invisible'><code>fn <a href='#method.frames' class='fnname'>frames</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="../backtrace/capture/struct.BacktraceFrame.html" title="struct backtrace::capture::BacktraceFrame">BacktraceFrame</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h4>
|
||
<div class='docblock'><p>Returns the frames from when this backtrace was captured.</p>
|
||
|
||
<p>The first entry of this slice is likely the function <code>Backtrace::new</code>,
|
||
and the last frame is likely something about how this thread or the main
|
||
function started.</p>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><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="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#155-188' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../backtrace/capture/struct.BacktraceFrame.html" title="struct backtrace::capture::BacktraceFrame">BacktraceFrame</a>>> for <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#103-107' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../backtrace/capture/struct.BacktraceFrame.html" title="struct backtrace::capture::BacktraceFrame">BacktraceFrame</a>></code></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../backtrace/capture/struct.BacktraceFrame.html" title="struct backtrace::capture::BacktraceFrame">BacktraceFrame</a>>> for <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#95-101' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><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><<a class="struct" href="../backtrace/capture/struct.BacktraceFrame.html" title="struct backtrace::capture::BacktraceFrame">BacktraceFrame</a>>) -> <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><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="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/backtrace/capture.rs.html#190-194' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span></h4>
|
||
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div><h3 class='impl'><span class='in-band'><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="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span><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></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a></code></span></h4>
|
||
</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 = "../";
|
||
window.currentCrate = "error_chain";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |