172 lines
7.9 KiB
HTML
172 lines
7.9 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 `example_generated` mod in crate `error_chain`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, example_generated">
|
||
|
||
<title>error_chain::example_generated - 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 example_generated</p><div class="block items"><ul><li><a href="#modules">Modules</a></li><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'>error_chain</a></p><script>window.sidebarCurrent = {name: 'example_generated', 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'>error_chain</a>::<wbr><a class="mod" href=''>example_generated</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/example_generated.rs.html#1-38' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>These modules show an example of code generated by the macro. <strong>IT MUST NOT BE
|
||
USED OUTSIDE THIS CRATE</strong>.</p>
|
||
|
||
<p>This is the basic error structure. You can see that <code>ErrorKind</code>
|
||
has been populated in a variety of ways. All <code>ErrorKind</code>s get a
|
||
<code>Msg</code> variant for basic errors. When strings are converted to
|
||
<code>ErrorKind</code>s they become <code>ErrorKind::Msg</code>. The "links" defined in
|
||
the macro are expanded to the <code>Inner</code> variant, and the
|
||
"foreign links" to the <code>Io</code> variant.</p>
|
||
|
||
<p>Both types come with a variety of <code>From</code> conversions as well:
|
||
<code>Error</code> can be created from <code>ErrorKind</code>, <code>&str</code> and <code>String</code>,
|
||
and the <code>links</code> and <code>foreign_links</code> error types. <code>ErrorKind</code>
|
||
can be created from the corresponding <code>ErrorKind</code>s of the link
|
||
types, as well as from <code>&str</code> and <code>String</code>.</p>
|
||
|
||
<p><code>into()</code> and <code>From::from</code> are used heavily to massage types into
|
||
the right shape. Which one to use in any specific case depends on
|
||
the influence of type inference, but there are some patterns that
|
||
arise frequently.</p>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="inner/index.html"
|
||
title='mod error_chain::example_generated::inner'>inner</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Another code generated by the macro.</p>
|
||
</td>
|
||
</tr></table><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 error_chain::example_generated::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 error_chain::example_generated::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 error_chain::example_generated::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 error_chain::example_generated::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 = "error_chain";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |