pnmixer-rust/w_result/index.html

128 lines
5.0 KiB
HTML
Raw Normal View History

2017-07-14 23:24:09 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
2017-07-16 21:37:37 +00:00
<meta name="description" content="API documentation for the Rust `w_result` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, w_result">
2017-07-14 23:24:09 +00:00
2017-07-16 21:37:37 +00:00
<title>w_result - Rust</title>
2017-07-14 23:24:09 +00:00
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
2017-07-16 21:37:37 +00:00
<body class="rustdoc mod">
2017-07-14 23:24:09 +00:00
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
2017-07-16 21:37:37 +00:00
<p class='location'>Crate w_result</p><div class="block items"><ul><li><a href="#reexports">Reexports</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'w_result', ty: 'mod', relpath: '../'};</script>
2017-07-14 23:24:09 +00:00
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
2017-07-16 21:37:37 +00:00
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>w_result</a></span><span class='out-of-band'><span id='render-detail'>
2017-07-14 23:24:09 +00:00
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
2017-07-16 21:37:37 +00:00
</span><a class='srclink' href='../src/w_result/lib.rs.html#1-374' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Defines <code>WResult</code>, a result type that carries warnings.</p>
<p>Sometimes it may be possible for an operation to proceed despite encountering errors. In these
cases, the caller may need to know about the errors that occured. <code>WResult</code> is similar to
<code>Result</code> except that the ok variant carries a vector of accumulated warnings. It comes with
methods for converting to a <code>Result</code> by discarding or logging the warnings or treating them as
errors.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
<table><tr><td><code>pub use self::<a class="enum" href="../w_result/enum.WResult.html" title="enum w_result::WResult">WResult</a>::*;</code></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.WResult.html"
title='enum w_result::WResult'>WResult</a></td>
<td class='docblock-short'>
<p>A result type that carries warnings.</p>
</td>
</tr></table></section>
2017-07-14 23:24:09 +00:00
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
2017-07-16 21:37:37 +00:00
window.currentCrate = "w_result";
2017-07-14 23:24:09 +00:00
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>