mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
64 lines
20 KiB
HTML
64 lines
20 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="Provides the `context` method for `Option` when porting from `anyhow`"><title>ContextCompat 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">☰</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="#">ContextCompat</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.context">context</a></li><li><a href="#tymethod.with_context">with_context</a></li><li><a href="#tymethod.wrap_err">wrap_err</a></li><li><a href="#tymethod.wrap_err_with">wrap_err_with</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ContextCompat%3CT%3E-for-Option%3CT%3E">Option<T></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="#">ContextCompat</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#1226-1254">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ContextCompat<T>: Sealed {
|
||
// Required methods
|
||
fn <a href="#tymethod.context" class="fn">context</a><D>(self, msg: D) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>>
|
||
<span class="where">where D: <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>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.with_context" class="fn">with_context</a><D, F>(self, f: F) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>>
|
||
<span class="where">where D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.wrap_err" class="fn">wrap_err</a><D>(self, msg: D) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>>
|
||
<span class="where">where D: <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>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.wrap_err_with" class="fn">wrap_err_with</a><D, F>(self, f: F) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>>
|
||
<span class="where">where D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D</span>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides the <code>context</code> method for <code>Option</code> when porting from <code>anyhow</code></p>
|
||
<p>This trait is sealed and cannot be implemented for types outside of
|
||
<code>eyre</code>.</p>
|
||
<h3 id="why-doesnt-eyre-impl-wraperr-for-option"><a href="#why-doesnt-eyre-impl-wraperr-for-option">Why Doesn’t <code>Eyre</code> impl <code>WrapErr</code> for <code>Option</code>?</a></h3>
|
||
<p><code>eyre</code> doesn’t impl <code>WrapErr</code> for <code>Option</code> because <code>wrap_err</code> implies that you’re creating a
|
||
new error that saves the previous error as its <code>source</code>. Calling <code>wrap_err</code> on an <code>Option</code> is
|
||
meaningless because there is no source error. <code>anyhow</code> avoids this issue by using a different
|
||
mental model where you’re adding “context” to an error, though this not a mental model for
|
||
error handling that <code>eyre</code> agrees with.</p>
|
||
<p>Instead, <code>eyre</code> encourages users to think of each error as distinct, where the previous error
|
||
is the context being saved by the new error, which is backwards compared to anyhow’s model. In
|
||
this model you’re encouraged to use combinators provided by <code>std</code> for <code>Option</code> to convert an
|
||
option to a <code>Result</code></p>
|
||
<h2 id="example"><a href="#example">Example</a></h2>
|
||
<p>Instead of:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>eyre::ContextCompat;
|
||
|
||
<span class="kw">fn </span>get_thing(<span class="kw-2">mut </span>things: <span class="kw">impl </span>Iterator<Item = u32>) -> eyre::Result<u32> {
|
||
things
|
||
.find(|<span class="kw-2">&</span>thing| thing == <span class="number">42</span>)
|
||
.context(<span class="string">"the thing wasnt in the list"</span>)
|
||
}</code></pre></div>
|
||
<p>We encourage you to use this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>eyre::eyre;
|
||
|
||
<span class="kw">fn </span>get_thing(<span class="kw-2">mut </span>things: <span class="kw">impl </span>Iterator<Item = u32>) -> eyre::Result<u32> {
|
||
things
|
||
.find(|<span class="kw-2">&</span>thing| thing == <span class="number">42</span>)
|
||
.ok_or_else(|| <span class="macro">eyre!</span>(<span class="string">"the thing wasnt in the list"</span>))
|
||
}</code></pre></div>
|
||
</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.context" class="method"><a class="src rightside" href="../src/eyre/lib.rs.html#1230-1232">source</a><h4 class="code-header">fn <a href="#tymethod.context" class="fn">context</a><D>(self, msg: D) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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>Compatibility version of <code>wrap_err</code> for creating new errors with new source on <code>Option</code>
|
||
when porting from <code>anyhow</code></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_context" class="method"><a class="src rightside" href="../src/eyre/lib.rs.html#1237-1240">source</a><h4 class="code-header">fn <a href="#tymethod.with_context" class="fn">with_context</a><D, F>(self, f: F) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D,</div></h4></section></summary><div class="docblock"><p>Compatibility version of <code>wrap_err_with</code> for creating new errors with new source on <code>Option</code>
|
||
when porting from <code>anyhow</code></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wrap_err" class="method"><a class="src rightside" href="../src/eyre/lib.rs.html#1244-1246">source</a><h4 class="code-header">fn <a href="#tymethod.wrap_err" class="fn">wrap_err</a><D>(self, msg: D) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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>Compatibility re-export of <code>context</code> for porting from <code>anyhow</code> to <code>eyre</code></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wrap_err_with" class="method"><a class="src rightside" href="../src/eyre/lib.rs.html#1250-1253">source</a><h4 class="code-header">fn <a href="#tymethod.wrap_err_with" class="fn">wrap_err_with</a><D, F>(self, f: F) -> <a class="type" href="type.Result.html" title="type eyre::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D,</div></h4></section></summary><div class="docblock"><p>Compatibility re-export of <code>with_context</code> for porting from <code>anyhow</code> to <code>eyre</code></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-ContextCompat%3CT%3E-for-Option%3CT%3E" class="impl"><a class="src rightside" href="../src/eyre/context.rs.html#81-117">source</a><a href="#impl-ContextCompat%3CT%3E-for-Option%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.ContextCompat.html" title="trait eyre::ContextCompat">ContextCompat</a><T> 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><T></h3></section></summary><div class="impl-items"><section id="method.wrap_err" class="method trait-impl"><a class="src rightside" href="../src/eyre/context.rs.html#82-87">source</a><a href="#method.wrap_err" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.wrap_err" class="fn">wrap_err</a><D>(self, msg: D) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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><section id="method.wrap_err_with" class="method trait-impl"><a class="src rightside" href="../src/eyre/context.rs.html#89-95">source</a><a href="#method.wrap_err_with" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.wrap_err_with" class="fn">wrap_err_with</a><D, F>(self, msg: F) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D,</div></h4></section><section id="method.context" class="method trait-impl"><a class="src rightside" href="../src/eyre/context.rs.html#97-105">source</a><a href="#method.context" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.context" class="fn">context</a><D>(self, msg: D) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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><section id="method.with_context" class="method trait-impl"><a class="src rightside" href="../src/eyre/context.rs.html#107-116">source</a><a href="#method.with_context" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.with_context" class="fn">with_context</a><D, F>(self, msg: F) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.Report.html" title="struct eyre::Report">Report</a>><div class="where">where
|
||
D: <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,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> D,</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.ContextCompat.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |