55 lines
5.9 KiB
HTML
55 lines
5.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="Gets the value in the `Ok` variant."><title>unwrap_ok in const_panic - 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="const_panic" 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="../const_panic/index.html">const_<wbr>panic</a><span class="version">0.2.10</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">unwrap_<wbr>ok</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#example" title="Example">Example</a><ul><li><a href="#error" title="Error">Error</a></li></ul></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate const_<wbr>panic</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">const_panic</a></span><h1>Macro <span class="macro">unwrap_ok</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/const_panic/macros/unwrapping.rs.html#128-140">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! unwrap_ok {
|
|
($res:expr) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Gets the value in the <code>Ok</code> variant.</p>
|
|
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
|
<p>This panics if <code>$res</code> is an <code>Err</code>, including the debug-formatted error in the panic message.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<p>The struct formatting below requires the <code>"non_basic"</code> feature (enabled by default)</p>
|
|
|
|
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>const_panic::unwrap_ok;
|
|
|
|
<span class="kw">const </span>SUM: u64 = <span class="macro">unwrap_ok!</span>(add_up_evens(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">4</span>, <span class="number">8</span>, <span class="number">16</span>]));
|
|
|
|
<span class="macro">assert_eq!</span>(SUM, <span class="number">30</span>);
|
|
|
|
<span class="kw">const fn </span>add_up_evens(slice: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><u64, OddError> {
|
|
<span class="kw">let </span><span class="kw-2">mut </span>sum = <span class="number">0u64</span>;
|
|
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
|
|
|
|
<span class="kw">while </span>i < slice.len() {
|
|
<span class="kw">let </span>x = slice[i];
|
|
|
|
<span class="kw">if </span>x % <span class="number">2 </span>== <span class="number">1 </span>{
|
|
<span class="kw">return </span><span class="prelude-val">Err</span>(OddError{at: i, number: x});
|
|
}
|
|
|
|
sum += x <span class="kw">as </span>u64;
|
|
i += <span class="number">1</span>;
|
|
}
|
|
|
|
<span class="prelude-val">Ok</span>(sum)
|
|
}
|
|
|
|
|
|
<span class="kw">struct </span>OddError {
|
|
at: usize,
|
|
number: u8,
|
|
}
|
|
|
|
<span class="comment">// You can also use `#[derive(PanicFmt))]` with the "derive" feature
|
|
</span><span class="macro">const_panic::impl_panicfmt!</span>{
|
|
<span class="kw">struct </span>OddError {
|
|
at: usize,
|
|
number: u8,
|
|
}
|
|
}
|
|
</code></pre></div>
|
|
<h4 id="error"><a class="doc-anchor" href="#error">§</a>Error</h4>
|
|
<p>This is what the compile-time error looks like when attempting to unwrap an <code>Err</code>:</p>
|
|
<div class="example-wrap"><pre class="language-text"><code>error[E0080]: evaluation of constant value failed
|
|
--> src/macros/unwrapping.rs:51:18
|
|
|
|
|
6 | const SUM: u64 = unwrap_ok!(add_up_evens(&[3, 5, 8, 13]));
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the evaluated program panicked at '
|
|
invoked `unwrap_ok` macro with an `Err` value: OddError { at: 0, number: 3 }', src/macros/unwrapping.rs:6:18
|
|
|</code></pre></div></div></details></section></div></main></body></html> |