blob: 84a07ef785e0ae54dc806eb3f6647ed5dc75cec7 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/value-bag-1.4.0/src/internal/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../value_bag/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../value_bag/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
</pre><pre class="rust"><code><span class="kw">use crate</span>::{
fill::Slot,
std::{any::Any, error},
ValueBag,
};
<span class="kw">use </span><span class="kw">super</span>::Internal;
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;v</span>&gt; ValueBag&lt;<span class="lifetime">&#39;v</span>&gt; {
<span class="doccomment">/// Get a value from an error.
</span><span class="kw">pub fn </span>capture_error&lt;T&gt;(value: <span class="kw-2">&amp;</span><span class="lifetime">&#39;v </span>T) -&gt; <span class="self">Self
</span><span class="kw">where
</span>T: error::Error + <span class="lifetime">&#39;static</span>,
{
ValueBag {
inner: Internal::Error(value),
}
}
<span class="doccomment">/// Get a value from an erased value.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_dyn_error(value: <span class="kw-2">&amp;</span><span class="lifetime">&#39;v </span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>)) -&gt; <span class="self">Self </span>{
ValueBag {
inner: Internal::AnonError(value),
}
}
<span class="doccomment">/// Try get an error from this value.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>to_borrowed_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;v </span>(<span class="kw">dyn </span>Error + <span class="lifetime">&#39;static</span>)&gt; {
<span class="kw">match </span><span class="self">self</span>.inner {
Internal::Error(value) =&gt; <span class="prelude-val">Some</span>(value.as_super()),
Internal::AnonError(value) =&gt; <span class="prelude-val">Some</span>(value),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;error&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>DowncastError {
<span class="kw">fn </span>as_any(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="kw">dyn </span>Any;
<span class="kw">fn </span>as_super(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;error&quot;</span>)]
</span><span class="kw">impl</span>&lt;T: error::Error + <span class="lifetime">&#39;static</span>&gt; DowncastError <span class="kw">for </span>T {
<span class="kw">fn </span>as_any(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="kw">dyn </span>Any {
<span class="self">self
</span>}
<span class="kw">fn </span>as_super(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>) {
<span class="self">self
</span>}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;s</span>, <span class="lifetime">&#39;f</span>&gt; Slot&lt;<span class="lifetime">&#39;s</span>, <span class="lifetime">&#39;f</span>&gt; {
<span class="doccomment">/// Fill the slot with an error.
///
/// The given value doesn&#39;t need to satisfy any particular lifetime constraints.
</span><span class="kw">pub fn </span>fill_error&lt;T&gt;(<span class="self">self</span>, value: T) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="kw">crate</span>::Error&gt;
<span class="kw">where
</span>T: error::Error + <span class="lifetime">&#39;static</span>,
{
<span class="self">self</span>.fill(|visitor| visitor.error(<span class="kw-2">&amp;</span>value))
}
<span class="doccomment">/// Fill the slot with an error.
</span><span class="kw">pub fn </span>fill_dyn_error(<span class="self">self</span>, value: <span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>)) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="kw">crate</span>::Error&gt; {
<span class="self">self</span>.fill(|visitor| visitor.error(value))
}
}
<span class="kw">pub use </span><span class="self">self</span>::error::Error;
<span class="attribute">#[cfg(feature = <span class="string">&quot;owned&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>owned {
<span class="kw">use </span><span class="kw">crate</span>::std::{boxed::Box, error, fmt, string::ToString};
<span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>OwnedError {
display: Box&lt;str&gt;,
source: <span class="prelude-ty">Option</span>&lt;Box&lt;OwnedError&gt;&gt;,
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>OwnedError {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
fmt::Display::fmt(<span class="kw-2">&amp;</span><span class="self">self</span>.display, f)
}
}
<span class="kw">impl </span>error::Error <span class="kw">for </span>OwnedError {
<span class="kw">fn </span>source(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>)&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>source) = <span class="self">self</span>.source {
<span class="prelude-val">Some</span>(<span class="kw-2">&amp;**</span>source)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>buffer(err: <span class="kw-2">&amp;</span>(<span class="kw">dyn </span>error::Error + <span class="lifetime">&#39;static</span>)) -&gt; OwnedError {
OwnedError {
display: err.to_string().into(),
source: err.source().map(buffer).map(Box::new),
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;wasm32&quot;</span>)]
</span><span class="kw">use </span>wasm_bindgen_test::<span class="kw-2">*</span>;
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use crate</span>::{
std::{io, string::ToString},
test::<span class="kw-2">*</span>,
};
<span class="attribute">#[test]
#[cfg_attr(target_arch = <span class="string">&quot;wasm32&quot;</span>, wasm_bindgen_test)]
</span><span class="kw">fn </span>error_capture() {
<span class="kw">let </span>err = io::Error::from(io::ErrorKind::Other);
<span class="macro">assert_eq!</span>(
err.to_string(),
ValueBag::capture_error(<span class="kw-2">&amp;</span>err)
.to_borrowed_error()
.expect(<span class="string">&quot;invalid value&quot;</span>)
.to_string()
);
<span class="macro">assert_eq!</span>(
err.to_string(),
ValueBag::from_dyn_error(<span class="kw-2">&amp;</span>err)
.to_borrowed_error()
.expect(<span class="string">&quot;invalid value&quot;</span>)
.to_string()
);
}
<span class="attribute">#[test]
#[cfg_attr(target_arch = <span class="string">&quot;wasm32&quot;</span>, wasm_bindgen_test)]
</span><span class="kw">fn </span>error_downcast() {
<span class="kw">let </span>err = io::Error::from(io::ErrorKind::Other);
<span class="macro">assert!</span>(ValueBag::capture_error(<span class="kw-2">&amp;</span>err)
.downcast_ref::&lt;io::Error&gt;()
.is_some());
}
<span class="attribute">#[test]
#[cfg_attr(target_arch = <span class="string">&quot;wasm32&quot;</span>, wasm_bindgen_test)]
</span><span class="kw">fn </span>error_visit() {
<span class="kw">let </span>err = io::Error::from(io::ErrorKind::Other);
ValueBag::from_dyn_error(<span class="kw-2">&amp;</span>err)
.visit(TestVisit::default())
.expect(<span class="string">&quot;failed to visit value&quot;</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="value_bag" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>