160 lines
6.5 KiB
HTML
160 lines
6.5 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 `bail` macro in crate `error_chain`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, bail">
|
||
|
||
<title>error_chain::bail - 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 macro">
|
||
<!--[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'><a href='index.html'>error_chain</a></p><script>window.sidebarCurrent = {name: 'bail', ty: 'macro', 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'>Macro <a href='index.html'>error_chain</a>::<wbr><a class="macro" href=''>bail</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#672-679' title='goto source code'>[src]</a></span></h1>
|
||
<pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">bail</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">e</span>:<span class="ident">expr</span>) <span class="op">=></span> { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">fmt</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=></span> { ... };
|
||
}</pre>
|
||
<div class='docblock'><p>Exits a function early with an error</p>
|
||
|
||
<p>The <code>bail!</code> macro provides an easy way to exit a function.
|
||
<code>bail!(expr)</code> is equivalent to writing.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">expr</span>.<span class="ident">into</span>());</pre>
|
||
|
||
<p>And as shorthand it takes a formatting string a la <code>println!</code>:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="macro">bail</span><span class="macro">!</span>(<span class="string">"bad number: {}"</span>, <span class="ident">n</span>);</pre>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<p>Bailing on a custom error:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="macro">error_chain</span><span class="macro">!</span> {
|
||
<span class="ident">errors</span> { <span class="ident">FooError</span> }
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">foo</span>() <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">bad_condition</span>() {
|
||
<span class="macro">bail</span><span class="macro">!</span>(<span class="ident">ErrorKind</span>::<span class="ident">FooError</span>);
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(())
|
||
}
|
||
</pre>
|
||
|
||
<p>Bailing on a formatted string:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="macro">error_chain</span><span class="macro">!</span> { }
|
||
|
||
<span class="kw">fn</span> <span class="ident">foo</span>() <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">bad_num</span>) <span class="op">=</span> <span class="ident">bad_condition</span>() {
|
||
<span class="macro">bail</span><span class="macro">!</span>(<span class="string">"so bad: {}"</span>, <span class="ident">bad_num</span>);
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(())
|
||
}
|
||
</pre>
|
||
</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> |