Initial gh-pages commit
This commit is contained in:
10
errors/Error.t.html
Normal file
10
errors/Error.t.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=struct.Error.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="struct.Error.html">struct.Error.html</a>...</p>
|
||||
<script>location.replace("struct.Error.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
errors/ErrorKind.t.html
Normal file
10
errors/ErrorKind.t.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=enum.ErrorKind.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="enum.ErrorKind.html">enum.ErrorKind.html</a>...</p>
|
||||
<script>location.replace("enum.ErrorKind.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
errors/Result.t.html
Normal file
10
errors/Result.t.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=type.Result.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="type.Result.html">type.Result.html</a>...</p>
|
||||
<script>location.replace("type.Result.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
10
errors/ResultExt.t.html
Normal file
10
errors/ResultExt.t.html
Normal file
@@ -0,0 +1,10 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=trait.ResultExt.html">
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="trait.ResultExt.html">trait.ResultExt.html</a>...</p>
|
||||
<script>location.replace("trait.ResultExt.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
139
errors/enum.ErrorKind.html
Normal file
139
errors/enum.ErrorKind.html
Normal file
@@ -0,0 +1,139 @@
|
||||
<!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 `pnmixerlib`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, ErrorKind">
|
||||
|
||||
<title>pnmixerlib::errors::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'>pnmixerlib</a>::<wbr><a href='index.html'>errors</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'>pnmixerlib</a>::<wbr><a href='index.html'>errors</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></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>),
|
||||
Alsa(<a class="struct" href="../../alsa/error/struct.Error.html" title="struct alsa::error::Error">Error</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>),
|
||||
Toml(<a class="struct" href="../../toml/de/struct.Error.html" title="struct toml::de::Error">Error</a>),
|
||||
Png(<a class="enum" href="../../png/decoder/stream/enum.DecodingError.html" title="enum png::decoder::stream::DecodingError">DecodingError</a>),
|
||||
}</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.Alsa' class='variant'><span id='Alsa.v' class='invisible'><code>Alsa(<a class="struct" href="../../alsa/error/struct.Error.html" title="struct alsa::error::Error">Error</a>)</code></span></span><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><span id='variant.Toml' class='variant'><span id='Toml.v' class='invisible'><code>Toml(<a class="struct" href="../../toml/de/struct.Error.html" title="struct toml::de::Error">Error</a>)</code></span></span><span id='variant.Png' class='variant'><span id='Png.v' class='invisible'><code>Png(<a class="enum" href="../../png/decoder/stream/enum.DecodingError.html" title="enum png::decoder::stream::DecodingError">DecodingError</a>)</code></span></span><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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> <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="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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>(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="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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 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="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>> for <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span><span class='out-of-band'></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>(e: <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::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 = "pnmixerlib";
|
||||
</script>
|
||||
<script src="../../main.js"></script>
|
||||
<script defer src="../../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
144
errors/index.html
Normal file
144
errors/index.html
Normal file
@@ -0,0 +1,144 @@
|
||||
<!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 `errors` mod in crate `pnmixerlib`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, errors">
|
||||
|
||||
<title>pnmixerlib::errors - 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 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">
|
||||
|
||||
<p class='location'>Module errors</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a></p><script>window.sidebarCurrent = {name: 'errors', ty: 'mod', 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'>Module <a href='../index.html'>pnmixerlib</a>::<wbr><a class="mod" href=''>errors</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/pnmixerlib/errors.rs.html#1-116' title='goto source code'>[src]</a></span></h1>
|
||||
<h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="struct" href="struct.Error.html"
|
||||
title='struct pnmixerlib::errors::Error'>Error</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>The Error type.</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.ErrorKind.html"
|
||||
title='enum pnmixerlib::errors::ErrorKind'>ErrorKind</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>The kind of an error.</p>
|
||||
</td>
|
||||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="trait" href="trait.ResultExt.html"
|
||||
title='trait pnmixerlib::errors::ResultExt'>ResultExt</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Additional methods for <code>Result</code>, for easy interaction with this crate.</p>
|
||||
</td>
|
||||
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||||
<table>
|
||||
<tr class=' module-item'>
|
||||
<td><a class="type" href="type.Result.html"
|
||||
title='type pnmixerlib::errors::Result'>Result</a></td>
|
||||
<td class='docblock-short'>
|
||||
<p>Convenient wrapper around <code>std::Result</code>.</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>?</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 = "pnmixerlib";
|
||||
</script>
|
||||
<script src="../../main.js"></script>
|
||||
<script defer src="../../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
1
errors/sidebar-items.js
Normal file
1
errors/sidebar-items.js
Normal file
@@ -0,0 +1 @@
|
||||
initSidebarItems({"enum":[["ErrorKind","The kind of an error."]],"struct":[["Error","The Error type."]],"trait":[["ResultExt","Additional methods for `Result`, for easy interaction with this crate."]],"type":[["Result","Convenient wrapper around `std::Result`."]]});
|
||||
197
errors/struct.Error.html
Normal file
197
errors/struct.Error.html
Normal file
@@ -0,0 +1,197 @@
|
||||
<!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 `Error` struct in crate `pnmixerlib`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, Error">
|
||||
|
||||
<title>pnmixerlib::errors::Error - 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 Error</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#deref-methods">Methods from Deref<Target=ErrorKind></a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a></p><script>window.sidebarCurrent = {name: 'Error', 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'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a>::<wbr><a class="struct" href=''>Error</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></span></h1>
|
||||
<pre class='rust struct'>pub struct Error(pub <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>, _);</pre><div class='docblock'><p>The Error type.</p>
|
||||
|
||||
<p>This tuple struct is made of two elements:</p>
|
||||
|
||||
<ul>
|
||||
<li>an <code>ErrorKind</code> which is used to determine the type of the error.</li>
|
||||
<li>An internal <code>State</code>, not meant for direct use outside of <code>error_chain</code>
|
||||
internals, containing:
|
||||
|
||||
<ul>
|
||||
<li>a backtrace, generated when the error is created.</li>
|
||||
<li>an error chain, used for the implementation of <code>Error::cause()</code>.</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='method.from_kind' class="method"><span id='from_kind.v' class='invisible'><code>fn <a href='#method.from_kind' class='fnname'>from_kind</a>(kind: <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>) -> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span></h4>
|
||||
<div class='docblock'><p>Constructs an error from a kind, and generates a backtrace.</p>
|
||||
</div><h4 id='method.with_chain' class="method"><span id='with_chain.v' class='invisible'><code>fn <a href='#method.with_chain' class='fnname'>with_chain</a><E, K>(error: E, kind: K) -> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a> <span class="where fmt-newline">where<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> + '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><<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>>, </span></code></span></h4>
|
||||
<div class='docblock'><p>Constructs a chained error from another error and a kind, and generates a backtrace.</p>
|
||||
</div><h4 id='method.kind' class="method"><span id='kind.v' class='invisible'><code>fn <a href='#method.kind' class='fnname'>kind</a>(&self) -> &<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span></h4>
|
||||
<div class='docblock'><p>Returns the kind of the error.</p>
|
||||
</div><h4 id='method.iter' class="method"><span id='iter.v' class='invisible'><code>fn <a href='#method.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../../error_chain/struct.ErrorChainIter.html" title="struct error_chain::ErrorChainIter">ErrorChainIter</a></code></span></h4>
|
||||
<div class='docblock'><p>Iterates over the error chain.</p>
|
||||
</div><h4 id='method.backtrace' class="method"><span id='backtrace.v' class='invisible'><code>fn <a href='#method.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="../../backtrace/capture/struct.Backtrace.html" title="struct backtrace::capture::Backtrace">Backtrace</a>></code></span></h4>
|
||||
<div class='docblock'><p>Returns the backtrace associated with this error.</p>
|
||||
</div><h4 id='method.chain_err' class="method"><span id='chain_err.v' class='invisible'><code>fn <a href='#method.chain_err' class='fnname'>chain_err</a><F, EK>(self, error: F) -> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a> <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><<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>>, </span></code></span></h4>
|
||||
<div class='docblock'><p>Extends the error chain with a new entry.</p>
|
||||
</div></div><h2 id='deref-methods'>Methods from <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>></h2><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="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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="../../error_chain/trait.ChainedError.html" title="trait error_chain::ChainedError">ChainedError</a> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='associatedtype.ErrorKind' class="type"><span id='ErrorKind.t' class='invisible'><code>type <a href='../../error_chain/trait.ChainedError.html#associatedtype.ErrorKind' class="type">ErrorKind</a> = <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span></h4>
|
||||
<div class='docblock'><p>Associated kind type.</p>
|
||||
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#tymethod.new' class='fnname'>new</a>(kind: <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>, state: State) -> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span></h4>
|
||||
<h4 id='method.from_kind-1' class="method"><span id='from_kind.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#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</code></span></h4>
|
||||
<div class='docblock'><p>Constructs an error from a kind, and generates a backtrace.</p>
|
||||
</div><h4 id='method.with_chain-1' class="method"><span id='with_chain.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#tymethod.with_chain' class='fnname'>with_chain</a><E, K>(error: E, kind: K) -> Self <span class="where fmt-newline">where<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> + '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></h4>
|
||||
<div class='docblock'><p>Constructs a chained error from another error and a kind, and generates a backtrace.</p>
|
||||
</div><h4 id='method.kind-1' class="method"><span id='kind.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#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></h4>
|
||||
<div class='docblock'><p>Returns the kind of the error.</p>
|
||||
</div><h4 id='method.iter-1' class="method"><span id='iter.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#tymethod.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../../error_chain/struct.ErrorChainIter.html" title="struct error_chain::ErrorChainIter">ErrorChainIter</a></code></span></h4>
|
||||
<div class='docblock'><p>Iterates over the error chain.</p>
|
||||
</div><h4 id='method.chain_err-1' class="method"><span id='chain_err.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#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><<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>>, </span></code></span></h4>
|
||||
<div class='docblock'><p>Extends the error chain with a new entry.</p>
|
||||
</div><h4 id='method.backtrace-1' class="method"><span id='backtrace.v-1' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#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="../../backtrace/capture/struct.Backtrace.html" title="struct backtrace::capture::Backtrace">Backtrace</a>></code></span></h4>
|
||||
<div class='docblock'><p>Returns the backtrace associated with this error.</p>
|
||||
</div><h4 id='method.extract_backtrace' class="method"><span id='extract_backtrace.v' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#tymethod.extract_backtrace' class='fnname'>extract_backtrace</a>(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> + 'static)) -> <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="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a><<a class="struct" href="../../backtrace/capture/struct.Backtrace.html" title="struct backtrace::capture::Backtrace">Backtrace</a>>></code></span></h4>
|
||||
<h4 id='method.display' class="method"><span id='display.v' class='invisible'><code>fn <a href='../../error_chain/trait.ChainedError.html#method.display' class='fnname'>display</a>(&'a self) -> <a class="struct" href="../../error_chain/struct.Display.html" title="struct error_chain::Display">Display</a><'a, Self></code></span></h4>
|
||||
<div class='docblock'><p>Returns an object which implements <code>Display</code> for printing the full context of this error. <a href="../../error_chain/trait.ChainedError.html#method.display">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/std/error/trait.Error.html" title="trait std::error::Error">Error</a> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='method.description-1' class="method"><span id='description.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.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 short description of the error. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description">Read more</a></p>
|
||||
</div><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</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="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">Error</a>></code></span></h4>
|
||||
<div class='docblock'><p>The lower-level cause of this error, if any. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause">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/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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, f: &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="struct" href="../../alsa/error/struct.Error.html" title="struct alsa::error::Error">Error</a>> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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>(e: <a class="struct" href="../../alsa/error/struct.Error.html" title="struct alsa::error::Error">Error</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/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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>(e: <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</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="../../toml/de/struct.Error.html" title="struct toml::de::Error">Error</a>> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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>(e: <a class="struct" href="../../toml/de/struct.Error.html" title="struct toml::de::Error">Error</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="enum" href="../../png/decoder/stream/enum.DecodingError.html" title="enum png::decoder::stream::DecodingError">DecodingError</a>> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></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="enum" href="../../png/decoder/stream/enum.DecodingError.html" title="enum png::decoder::stream::DecodingError">DecodingError</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="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='method.from-4' class="method"><span id='from.v-4' 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="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::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="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='method.from-5' class="method"><span id='from.v-5' 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="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='method.from-6' class="method"><span id='from.v-6' 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/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a></code></span><span class='out-of-band'></span></h3>
|
||||
<div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a></code></span></h4>
|
||||
<div class='docblock'><p>The resulting type after dereferencing</p>
|
||||
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></span></h4>
|
||||
<div class='docblock'><p>The method called to dereference a value</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 = "pnmixerlib";
|
||||
</script>
|
||||
<script src="../../main.js"></script>
|
||||
<script defer src="../../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
132
errors/trait.ResultExt.html
Normal file
132
errors/trait.ResultExt.html
Normal file
@@ -0,0 +1,132 @@
|
||||
<!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 `ResultExt` trait in crate `pnmixerlib`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, ResultExt">
|
||||
|
||||
<title>pnmixerlib::errors::ResultExt - 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 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">
|
||||
|
||||
<p class='location'>Trait ResultExt</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a></p><script>window.sidebarCurrent = {name: 'ResultExt', ty: 'trait', 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'>Trait <a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a>::<wbr><a class="trait" href=''>ResultExt</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></span></h1>
|
||||
<pre class='rust trait'>pub trait ResultExt<T, E> {
|
||||
fn <a href='#tymethod.chain_err' class='fnname'>chain_err</a><F, EK>(self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>><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><<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>></span>;
|
||||
fn <a href='#tymethod.from_err' class='fnname'>from_err</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>><br> <span class="where">where<br> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><E></span>;
|
||||
}</pre><div class='docblock'><p>Additional methods for <code>Result</code>, for easy interaction with this crate.</p>
|
||||
</div>
|
||||
<h2 id='required-methods'>Required Methods</h2>
|
||||
<div class='methods'>
|
||||
<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, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>> <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><<a class="enum" href="../../pnmixerlib/errors/enum.ErrorKind.html" title="enum pnmixerlib::errors::ErrorKind">ErrorKind</a>>, </span></code></span></h3><div class='docblock'><p>If the <code>Result</code> is an <code>Err</code> then <code>chain_err</code> evaluates the closure,
|
||||
which returns <em>some type that can be converted to <code>ErrorKind</code></em>, boxes
|
||||
the original error to store as the cause, then returns a new error
|
||||
containing the original error.</p>
|
||||
</div><h3 id='tymethod.from_err' class='method'><span id='from_err.v' class='invisible'><code>fn <a href='#tymethod.from_err' class='fnname'>from_err</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>> <span class="where fmt-newline">where<br> <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><E>, </span></code></span></h3><div class='docblock'><p>Converts a convertible error via <code>From::from</code> to
|
||||
the result error. Useful to turn e.g. <code>std::io::Error</code>
|
||||
into our own Error type.</p>
|
||||
</div></div>
|
||||
<h2 id='implementors'>Implementors</h2>
|
||||
<ul class='item-list' id='implementors-list'>
|
||||
<li><code>impl<T, E> ResultExt<T, E> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E> <span class="where fmt-newline">where<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> + 'static, </span></code></li>
|
||||
</ul><script type="text/javascript" async
|
||||
src="../../implementors/pnmixerlib/errors/trait.ResultExt.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>?</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 = "pnmixerlib";
|
||||
</script>
|
||||
<script src="../../main.js"></script>
|
||||
<script defer src="../../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
113
errors/type.Result.html
Normal file
113
errors/type.Result.html
Normal file
@@ -0,0 +1,113 @@
|
||||
<!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 `Result` type in crate `pnmixerlib`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, Result">
|
||||
|
||||
<title>pnmixerlib::errors::Result - 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 type">
|
||||
<!--[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'>Type Definition Result</p><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a></p><script>window.sidebarCurrent = {name: 'Result', ty: 'type', 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'>Type Definition <a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>errors</a>::<wbr><a class="type" href=''>Result</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></span></h1>
|
||||
<pre class='rust typedef'>type Result<T> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>>;</pre><div class='docblock'><p>Convenient wrapper around <code>std::Result</code>.</p>
|
||||
</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 = "pnmixerlib";
|
||||
</script>
|
||||
<script src="../../main.js"></script>
|
||||
<script defer src="../../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user