<!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 to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/failure-0.1.1/src/sync_failure.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>sync_failure.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">Fail</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>::{<span class="self">self</span>, <span class="ident">Debug</span>, <span class="ident">Display</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Mutex</span>;
<span class="doccomment">/// Wrapper for `std` errors to make them `Sync`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This exists to coerce existing types that are only `Error + Send +</span>
<span class="doccomment">/// 'static` into a `Fail`-compatible representation, most notably for</span>
<span class="doccomment">/// types generated by `error-chain`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unfortunately, this requires wrapping the error in a `Mutex`, which must</span>
<span class="doccomment">/// be locked for every `Debug`/`Display`. Therefore, this should be</span>
<span class="doccomment">/// something of a last resort in making the error work with `failure`.</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SyncFailure</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">inner</span>: <span class="ident">Mutex</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Error</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span> <span class="ident">SyncFailure</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> {
<span class="doccomment">/// Wraps a non-`Sync` `Error` in order to make it implement `Fail`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// extern crate failure;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # use std::error::Error as StdError;</span>
<span class="doccomment">/// # use std::fmt::{self, Display};</span>
<span class="doccomment">/// use failure::{Error, SyncFailure};</span>
<span class="doccomment">/// use std::cell::RefCell;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// #[derive(Debug)]</span>
<span class="doccomment">/// struct NonSyncError {</span>
<span class="doccomment">/// // RefCells are non-Sync, so structs containing them will be</span>
<span class="doccomment">/// // non-Sync as well.</span>
<span class="doccomment">/// count: RefCell<usize>,</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // implement Display/Error for NonSyncError...</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # impl StdError for NonSyncError {</span>
<span class="doccomment">/// # fn description(&self) -> &str {</span>
<span class="doccomment">/// # "oops!"</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # impl Display for NonSyncError {</span>
<span class="doccomment">/// # fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {</span>
<span class="doccomment">/// # write!(f, "oops!")</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn returns_error() -> Result<(), NonSyncError> {</span>
<span class="doccomment">/// // Do stuff</span>
<span class="doccomment">/// # Ok(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn my_function() -> Result<(), Error> {</span>
<span class="doccomment">/// // without the map_err here, we end up with a compile error</span>
<span class="doccomment">/// // complaining that NonSyncError doesn't implement Sync.</span>
<span class="doccomment">/// returns_error().map_err(SyncFailure::new)?;</span>
<span class="doccomment">/// // Do more stuff</span>
<span class="doccomment">/// # Ok(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// # my_function().unwrap();</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">err</span>: <span class="ident">E</span>) <span class="op">-></span> <span class="self">Self</span> {
<span class="ident">SyncFailure</span> {
<span class="ident">inner</span>: <span class="ident">Mutex</span>::<span class="ident">new</span>(<span class="ident">err</span>),
}
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Display</span> <span class="kw">for</span> <span class="ident">SyncFailure</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Display</span>,
{
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>().<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">SyncFailure</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">T</span>: <span class="ident">Debug</span>,
{
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">lock</span>().<span class="ident">unwrap</span>().<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">Error</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span> <span class="ident">Fail</span> <span class="kw">for</span> <span class="ident">SyncFailure</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> {}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "failure";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>