145 lines
14 KiB
HTML
145 lines
14 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 `ErrorKind` enum in crate `error_chain`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind">
|
||
|
||
<title>error_chain::example_generated::ErrorKind - 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 enum">
|
||
<!--[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'>Enum ErrorKind</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><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>::<wbr><a href='index.html'>example_generated</a></p><script>window.sidebarCurrent = {name: 'ErrorKind', ty: 'enum', 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'>Enum <a href='../index.html'>error_chain</a>::<wbr><a href='index.html'>example_generated</a>::<wbr><a class="enum" href=''>ErrorKind</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/quick_error.rs.html#198-203' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust enum'>pub enum ErrorKind {
|
||
Msg(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
||
Inner(<a class="enum" href="../../error_chain/example_generated/inner/enum.ErrorKind.html" title="enum error_chain::example_generated::inner::ErrorKind">ErrorKind</a>),
|
||
Io(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>),
|
||
Custom,
|
||
}</pre><div class='docblock'><p>The kind of an error.</p>
|
||
</div><h2 id='variants' class='variants'>Variants</h2>
|
||
<span id='variant.Msg' class='variant'><span id='Msg.v' class='invisible'><code>Msg(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></span><div class='docblock'><p>A convenient variant for String.</p>
|
||
</div><span id='variant.Inner' class='variant'><span id='Inner.v' class='invisible'><code>Inner(<a class="enum" href="../../error_chain/example_generated/inner/enum.ErrorKind.html" title="enum error_chain::example_generated::inner::ErrorKind">ErrorKind</a>)</code></span></span><div class='docblock'><p>Link to another <code>ErrorChain</code>.</p>
|
||
</div><span id='variant.Io' class='variant'><span id='Io.v' class='invisible'><code>Io(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>)</code></span></span><div class='docblock'><p>Link to a <code>std::error::Error</code> type.</p>
|
||
</div><span id='variant.Custom' class='variant'><span id='Custom.v' class='invisible'><code>Custom</code></span></span><div class='docblock'><p>A custom error kind.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/quick_error.rs.html#314-330' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.description' class="method"><span id='description.v' class='invisible'><code>fn <a href='#method.description' class='fnname'>description</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></h4>
|
||
<div class='docblock'><p>A string describing the error kind.</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="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/error_chain.rs.html#246' 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, __arg_0: &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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</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/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/quick_error.rs.html#264-283' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">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/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../../error_chain/example_generated/inner/enum.ErrorKind.html" title="enum error_chain::example_generated::inner::ErrorKind">ErrorKind</a>> for <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/error_chain.rs.html#277-281' title='goto source code'>[src]</a></span></h3>
|
||
<div class='docblock'><p>Link to another <code>ErrorChain</code>.</p>
|
||
</div><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>(e: <a class="enum" href="../../error_chain/example_generated/inner/enum.ErrorKind.html" title="enum error_chain::example_generated::inner::ErrorKind">ErrorKind</a>) -> Self</code></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> for <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/error_chain.rs.html#284-288' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</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/string/struct.String.html" title="struct alloc::string::String">String</a>> for <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/error_chain.rs.html#290-294' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(s: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</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="../../error_chain/example_generated/struct.Error.html" title="struct error_chain::example_generated::Error">Error</a>> for <a class="enum" href="../../error_chain/example_generated/enum.ErrorKind.html" title="enum error_chain::example_generated::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/error_chain/error_chain.rs.html#296-300' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: <a class="struct" href="../../error_chain/example_generated/struct.Error.html" title="struct error_chain::example_generated::Error">Error</a>) -> Self</code></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</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>?</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> |