28 lines
4.4 KiB
HTML
28 lines
4.4 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="Returns the given error from this function."><title>fail in rancor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rancor" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rancor/index.html">rancor</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">fail</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rancor</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">rancor</a></span><h1>Macro <span class="macro">fail</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rancor/lib.rs.html#281-285">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! fail {
|
|
($($x:tt)*) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the given error from this function.</p>
|
|
<p>The current function must return a <code>Result<_, E></code> where <code>E</code> implements
|
|
<a href="trait.Source.html" title="trait rancor::Source"><code>Source</code></a>.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>core::{error::Error, fmt};
|
|
|
|
<span class="kw">use </span>rancor::{fail, Source};
|
|
|
|
<span class="attr">#[derive(Debug)]
|
|
</span><span class="kw">struct </span>DivideByZeroError;
|
|
|
|
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>DivideByZeroError {
|
|
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
|
<span class="macro">write!</span>(f, <span class="string">"attempted to divide by zero"</span>)
|
|
}
|
|
}
|
|
|
|
<span class="kw">impl </span>Error <span class="kw">for </span>DivideByZeroError {}
|
|
|
|
<span class="kw">fn </span>divide<E: Source>(a: i32, b: i32) -> <span class="prelude-ty">Result</span><i32, E> {
|
|
<span class="kw">if </span>b == <span class="number">0 </span>{
|
|
<span class="macro">fail!</span>(DivideByZeroError);
|
|
}
|
|
<span class="prelude-val">Ok</span>(a / b)
|
|
}</code></pre></div>
|
|
</div></details></section></div></main></body></html> |