172 lines
18 KiB
HTML
172 lines
18 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 `ChainedError` trait in crate `error_chain`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, ChainedError">
|
|||
|
|
|
|||
|
|
<title>error_chain::ChainedError - 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 trait">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<p class='location'>Trait ChainedError</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.ErrorKind">ErrorKind</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_kind">from_kind</a><a href="#tymethod.with_chain">with_chain</a><a href="#tymethod.kind">kind</a><a href="#tymethod.iter">iter</a><a href="#tymethod.backtrace">backtrace</a><a href="#tymethod.chain_err">chain_err</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.display_chain">display_chain</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>error_chain</a></p><script>window.sidebarCurrent = {name: 'ChainedError', ty: 'trait', 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">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>error_chain</a>::<wbr><a class="trait" href=''>ChainedError</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/error_chain/lib.rs.html#624-669' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait ChainedError: <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static {
|
|||
|
|
type <a href='#associatedtype.ErrorKind' class="type">ErrorKind</a>;
|
|||
|
|
fn <a href='#tymethod.from_kind' class='fnname'>from_kind</a>(kind: Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>) -> Self<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.with_chain' class='fnname'>with_chain</a><E, K>(error: E, kind: K) -> Self<br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.kind' class='fnname'>kind</a>(&self) -> &Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../error_chain/struct.Iter.html" title="struct error_chain::Iter">Iter</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.chain_err' class='fnname'>chain_err</a><F, EK>(self, error: F) -> Self<br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> EK,<br> EK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>></span>;
|
|||
|
|
|
|||
|
|
fn <a href='#method.display_chain' class='fnname'>display_chain</a><'a>(&'a self) -> <a class="struct" href="../error_chain/struct.DisplayChain.html" title="struct error_chain::DisplayChain">DisplayChain</a><'a, Self> { ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>This trait is implemented on all the errors generated by the <code>error_chain</code>
|
|||
|
|
macro.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.ErrorKind' class='method'><span id='ErrorKind.t' class='invisible'><code>type <a href='#associatedtype.ErrorKind' class="type">ErrorKind</a></code></span></h3><div class='docblock'><p>Associated kind type.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.from_kind' class='method'><span id='from_kind.v' class='invisible'><code>fn <a href='#tymethod.from_kind' class='fnname'>from_kind</a>(kind: Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>) -> Self <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h3><div class='docblock'><p>Constructs an error from a kind, and generates a backtrace.</p>
|
|||
|
|
</div><h3 id='tymethod.with_chain' class='method'><span id='with_chain.v' class='invisible'><code>fn <a href='#tymethod.with_chain' class='fnname'>with_chain</a><E, K>(error: E, kind: K) -> Self <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,<br> K: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>>, </span></code></span></h3><div class='docblock'><p>Constructs a chained error from another error and a kind, and generates a backtrace.</p>
|
|||
|
|
</div><h3 id='tymethod.kind' class='method'><span id='kind.v' class='invisible'><code>fn <a href='#tymethod.kind' class='fnname'>kind</a>(&self) -> &Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a></code></span></h3><div class='docblock'><p>Returns the kind of the error.</p>
|
|||
|
|
</div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../error_chain/struct.Iter.html" title="struct error_chain::Iter">Iter</a><'a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../error_chain/struct.Iter.html" title="struct error_chain::Iter">Iter</a><'a></h3><code class="content"><span class="where fmt-newline">impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../error_chain/struct.Iter.html" title="struct error_chain::Iter">Iter</a><'a></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &'a <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a>;</span></code></div></div><h3 id='tymethod.iter' class='method'><span id='iter.v' class='invisible'><code>fn <a href='#tymethod.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../error_chain/struct.Iter.html" title="struct error_chain::Iter">Iter</a></code></span></h3><div class='docblock'><p>Iterates over the error chain.</p>
|
|||
|
|
</div><h3 id='tymethod.backtrace' class='method'><span id='backtrace.v' class='invisible'><code>fn <a href='#tymethod.backtrace' class='fnname'>backtrace</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../error_chain/struct.Backtrace.html" title="struct error_chain::Backtrace">Backtrace</a>></code></span></h3><div class='docblock'><p>Returns the backtrace associated with this error.</p>
|
|||
|
|
</div><h3 id='tymethod.chain_err' class='method'><span id='chain_err.v' class='invisible'><code>fn <a href='#tymethod.chain_err' class='fnname'>chain_err</a><F, EK>(self, error: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> EK,<br> EK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Self::<a class="type" href="../error_chain/trait.ChainedError.html#associatedtype.ErrorKind" title="type error_chain::ChainedError::ErrorKind">ErrorKind</a>>, </span></code></span></h3><div class='docblock'><p>Extends the error chain with a new entry.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>
|
|||
|
|
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='method.display_chain' class='method'><span id='display_chain.v' class='invisible'><code>fn <a href='#method.display_chain' class='fnname'>display_chain</a><'a>(&'a self) -> <a class="struct" href="../error_chain/struct.DisplayChain.html" title="struct error_chain::DisplayChain">DisplayChain</a><'a, Self></code></span></h3><div class='docblock'><p>Returns an object which implements <code>Display</code> for printing the full
|
|||
|
|
context of this error.</p>
|
|||
|
|
<p>The full cause chain and backtrace, if present, will be printed.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl ChainedError for error_chain::example_generated::inner::<a class="struct" href="../error_chain/example_generated/inner/struct.Error.html" title="struct error_chain::example_generated::inner::Error">Error</a><span class="where fmt-newline"> type <a href='#associatedtype.ErrorKind' class="type">ErrorKind</a> = <a class="enum" href="../error_chain/example_generated/inner/enum.ErrorKind.html" title="enum error_chain::example_generated::inner::ErrorKind">ErrorKind</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/error_chain/error_chain.rs.html#77-117' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl ChainedError for error_chain::example_generated::<a class="struct" href="../error_chain/example_generated/struct.Error.html" title="struct error_chain::example_generated::Error">Error</a><span class="where fmt-newline"> type <a href='#associatedtype.ErrorKind' class="type">ErrorKind</a> = <a class="enum" href="../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/error_chain/error_chain.rs.html#77-117' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../implementors/error_chain/trait.ChainedError.js">
|
|||
|
|
</script></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>
|
|||
|
|
</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>
|