edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-09-20 01:24:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/eyre/trait.OptionExt.html
edg-l 5c4cbb28c1 deploy: 4a83cfd6f9
2024-02-13 06:38:44 +00:00

41 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Provides the `ok_or_eyre` method for `Option`."><title>OptionExt in eyre - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="eyre" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../eyre/index.html">eyre</a><span class="version">0.6.12</span></h2></div><h2 class="location"><a href="#">OptionExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.ok_or_eyre">ok_or_eyre</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-OptionExt%3CT%3E-for-Option%3CT%3E">Option&lt;T&gt;</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate eyre</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../eyre/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">eyre</a>::<wbr><a class="trait" href="#">OptionExt</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/eyre/lib.rs.html#1168-1181">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait OptionExt&lt;T&gt;: Sealed {
// Required method
fn <a href="#tymethod.ok_or_eyre" class="fn">ok_or_eyre</a>&lt;M&gt;(self, message: M) -&gt; <a class="type" href="type.Result.html" title="type eyre::Result">Result</a>&lt;T&gt;
<span class="where">where M: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static</span>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides the <a href="trait.OptionExt.html#tymethod.ok_or_eyre" title="method eyre::OptionExt::ok_or_eyre"><code>ok_or_eyre</code></a> method for <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option"><code>Option</code></a>.</p>
<p>This trait is sealed and cannot be implemented for types outside of
<code>eyre</code>.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>eyre::OptionExt;
<span class="kw">let </span>option: <span class="prelude-ty">Option</span>&lt;()&gt; = <span class="prelude-val">None</span>;
<span class="kw">let </span>result = option.ok_or_eyre(<span class="string">"static str error"</span>);
<span class="macro">assert_eq!</span>(result.unwrap_err().to_string(), <span class="string">"static str error"</span>);</code></pre></div>
<h2 id="ok_or_eyre-vs-ok_or_else"><a href="#ok_or_eyre-vs-ok_or_else"><code>ok_or_eyre</code> vs <code>ok_or_else</code></a></h2>
<p>If string interpolation is required for the generated <a href="struct.Report.html" title="struct eyre::Report">report</a>,
use <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html#method.ok_or_else" title="method core::option::Option::ok_or_else"><code>ok_or_else</code></a> instead,
invoking <a href="macro.format_err.html" title="macro eyre::format_err"><code>eyre!</code></a> to perform string interpolation:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>eyre::eyre;
<span class="kw">let </span>option: <span class="prelude-ty">Option</span>&lt;()&gt; = <span class="prelude-val">None</span>;
<span class="kw">let </span>result = option.ok_or_else(|| <span class="macro">eyre!</span>(<span class="string">"{} error"</span>, <span class="string">"dynamic"</span>));
<span class="macro">assert_eq!</span>(result.unwrap_err().to_string(), <span class="string">"dynamic error"</span>);</code></pre></div>
<p><code>ok_or_eyre</code> incurs no runtime cost, as the error object
is constructed from the provided static argument
only in the <code>None</code> case.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.ok_or_eyre" class="method"><a class="src rightside" href="../src/eyre/lib.rs.html#1178-1180">source</a><h4 class="code-header">fn <a href="#tymethod.ok_or_eyre" class="fn">ok_or_eyre</a>&lt;M&gt;(self, message: M) -&gt; <a class="type" href="type.Result.html" title="type eyre::Result">Result</a>&lt;T&gt;<div class="where">where
M: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></h4></section></summary><div class="docblock"><p>Transform the <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option"><code>Option&lt;T&gt;</code></a> into a <a href="type.Result.html" title="type eyre::Result"><code>Result&lt;T, E&gt;</code></a>,
mapping <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html#variant.Some" title="variant core::option::Option::Some"><code>Some(v)</code></a> to <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Ok(v)</code></a>
and <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> to <a href="struct.Report.html" title="struct eyre::Report"><code>Report</code></a>.</p>
<p><code>ok_or_eyre</code> allows for eyre <a href="struct.Report.html" title="struct eyre::Report"><code>Report</code></a> error objects
to be lazily created from static messages in the <code>None</code> case.</p>
<p>For dynamic error messages, use <a href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html#method.ok_or_else" title="method core::option::Option::ok_or_else"><code>ok_or_else</code></a>,
invoking <a href="macro.format_err.html" title="macro eyre::format_err"><code>eyre!</code></a> in the closure to perform string interpolation.</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-OptionExt%3CT%3E-for-Option%3CT%3E" class="impl"><a class="src rightside" href="../src/eyre/option.rs.html#4-15">source</a><a href="#impl-OptionExt%3CT%3E-for-Option%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.OptionExt.html" title="trait eyre::OptionExt">OptionExt</a>&lt;T&gt; for <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><section id="method.ok_or_eyre" class="method trait-impl"><a class="src rightside" href="../src/eyre/option.rs.html#6-14">source</a><a href="#method.ok_or_eyre" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.ok_or_eyre" class="fn">ok_or_eyre</a>&lt;M&gt;(self, message: M) -&gt; <a class="type" href="type.Result.html" title="type eyre::Result">Result</a>&lt;T&gt;<div class="where">where
M: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,</div></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/eyre/trait.OptionExt.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink