diff options
Diffstat (limited to 'src/carboxyl/source.rs.html')
| -rw-r--r-- | src/carboxyl/source.rs.html | 359 |
1 files changed, 359 insertions, 0 deletions
diff --git a/src/carboxyl/source.rs.html b/src/carboxyl/source.rs.html new file mode 100644 index 0000000..5aab27b --- /dev/null +++ b/src/carboxyl/source.rs.html @@ -0,0 +1,359 @@ +<!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 `/home/travis/.cargo/registry/src/github.com-0a35038f75765ae4/carboxyl-0.1.1/src/source.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>source.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + + + </section> + + <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 source"><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> +<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> +</pre><pre class='rust '> +<span class='doccomment'>//! Event sources and callbacks.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! This is a light-weight implementation of the observer pattern. Subjects are</span> +<span class='doccomment'>//! modelled as the `Source` type and observers as boxed closures.</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::{ <span class='ident'>RwLock</span>, <span class='ident'>Weak</span> }; + +<span class='doccomment'>/// An error that can occur with a weakly referenced callback.</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>PartialEq</span>, <span class='ident'>Eq</span>, <span class='ident'>Clone</span>, <span class='ident'>Copy</span>, <span class='ident'>Debug</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>CallbackError</span> { + <span class='ident'>Disappeared</span>, + <span class='ident'>Poisoned</span>, +} + +<span class='doccomment'>/// Shorthand for common callback results.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>CallbackResult</span><span class='op'><</span><span class='ident'>T</span><span class='op'>=</span>()<span class='op'>></span> <span class='op'>=</span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>CallbackError</span><span class='op'>></span>; + +<span class='doccomment'>/// A boxed callback.</span> +<span class='kw'>type</span> <span class='ident'>Callback</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>FnMut</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>CallbackResult</span> <span class='op'>+</span> <span class='ident'>Send</span> <span class='op'>+</span> <span class='ident'>Sync</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span>; + + +<span class='doccomment'>/// Perform some callback on a weak reference to a mutex and handle errors</span> +<span class='doccomment'>/// gracefully.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>with_weak</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>U</span>, <span class='ident'>F</span>: <span class='ident'>FnOnce</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>U</span><span class='op'>></span>(<span class='ident'>weak</span>: <span class='kw-2'>&</span><span class='ident'>Weak</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>T</span><span class='op'>>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>CallbackResult</span><span class='op'><</span><span class='ident'>U</span><span class='op'>></span> { + <span class='ident'>weak</span>.<span class='ident'>upgrade</span>() + .<span class='ident'>ok_or</span>(<span class='ident'>CallbackError</span>::<span class='ident'>Disappeared</span>) + .<span class='ident'>and_then</span>(<span class='op'>|</span><span class='ident'>mutex</span><span class='op'>|</span> <span class='ident'>mutex</span>.<span class='ident'>write</span>() + .<span class='ident'>map</span>(<span class='op'>|</span><span class='kw-2'>mut</span> <span class='ident'>t</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>t</span>)) + .<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>CallbackError</span>::<span class='ident'>Poisoned</span>) + ) +} + + +<span class='doccomment'>/// An event source.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>callbacks</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Callback</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span>, +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> <span class='ident'>Source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a new source.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>Source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Source</span> { <span class='ident'>callbacks</span>: <span class='macro'>vec</span><span class='macro'>!</span>[] } + } + + <span class='doccomment'>/// Register a callback. The callback will be a mutable closure that takes</span> + <span class='doccomment'>/// an event and must return a result. To unsubscribe from further events,</span> + <span class='doccomment'>/// the callback has to return an error.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>register</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>callback</span>: <span class='ident'>F</span>) + <span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>FnMut</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>CallbackResult</span> <span class='op'>+</span> <span class='ident'>Send</span> <span class='op'>+</span> <span class='ident'>Sync</span> <span class='op'>+</span> <span class='lifetime'>'static</span> + { + <span class='self'>self</span>.<span class='ident'>callbacks</span>.<span class='ident'>push</span>(<span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>callback</span>)); + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Send</span> <span class='op'>+</span> <span class='ident'>Sync</span> <span class='op'>+</span> <span class='ident'>Clone</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span> <span class='ident'>Source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Make the source send an event to all its observers.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>send</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>a</span>: <span class='ident'>A</span>) { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>mem</span>; + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>new_callbacks</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>(); + <span class='ident'>mem</span>::<span class='ident'>swap</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>new_callbacks</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='ident'>callbacks</span>); + <span class='self'>self</span>.<span class='ident'>callbacks</span> <span class='op'>=</span> <span class='ident'>new_callbacks</span> + .<span class='ident'>into_iter</span>() + .<span class='ident'>filter_map</span>(<span class='op'>|</span><span class='kw-2'>mut</span> <span class='ident'>callback</span><span class='op'>|</span> { + <span class='kw'>let</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='ident'>callback</span>(<span class='ident'>a</span>.<span class='ident'>clone</span>()); + <span class='kw'>match</span> <span class='ident'>result</span> { + <span class='prelude-val'>Ok</span>(_) <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>callback</span>), + <span class='prelude-val'>Err</span>(_) <span class='op'>=></span> <span class='prelude-val'>None</span>, + } + }) + .<span class='ident'>collect</span>(); + } +} + + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>mod</span> <span class='ident'>test</span> { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::{ <span class='ident'>Arc</span>, <span class='ident'>RwLock</span> }; + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>; + <span class='kw'>use</span> <span class='ident'>super</span>::<span class='op'>*</span>; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>with_weak_no_error</span>() { + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='number'>3</span>)); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>downgrade</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> { <span class='op'>*</span><span class='ident'>a</span> <span class='op'>=</span> <span class='number'>4</span>; }), <span class='prelude-val'>Ok</span>(())); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>a</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>(), <span class='number'>4</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>with_weak_disappeared</span>() { + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='number'>3</span>)).<span class='ident'>downgrade</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span>_<span class='op'>|</span> ()), <span class='prelude-val'>Err</span>(<span class='ident'>CallbackError</span>::<span class='ident'>Disappeared</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>with_weak_poisoned</span>() { + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='number'>3</span>)); + <span class='kw'>let</span> <span class='ident'>a2</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>downgrade</span>(); + <span class='kw'>let</span> _ <span class='op'>=</span> <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>_g</span> <span class='op'>=</span> <span class='ident'>a2</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>(); + <span class='macro'>panic</span><span class='macro'>!</span>(); + }).<span class='ident'>join</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span>_<span class='op'>|</span> ()), <span class='prelude-val'>Err</span>(<span class='ident'>CallbackError</span>::<span class='ident'>Poisoned</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>source_register_and_send</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>src</span> <span class='op'>=</span> <span class='ident'>Source</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='number'>3</span>)); + { + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>clone</span>(); + <span class='ident'>src</span>.<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> { + <span class='op'>*</span><span class='ident'>a</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>() <span class='op'>=</span> <span class='ident'>x</span>; + <span class='prelude-val'>Ok</span>(()) + }); + } + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>src</span>.<span class='ident'>callbacks</span>.<span class='ident'>len</span>(), <span class='number'>1</span>); + <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>a</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>(), <span class='number'>4</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>source_unregister</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>src</span> <span class='op'>=</span> <span class='ident'>Source</span>::<span class='ident'>new</span>(); + <span class='ident'>src</span>.<span class='ident'>register</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='prelude-val'>Err</span>(<span class='ident'>CallbackError</span>::<span class='ident'>Disappeared</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>src</span>.<span class='ident'>callbacks</span>.<span class='ident'>len</span>(), <span class='number'>1</span>); + <span class='ident'>src</span>.<span class='ident'>send</span>(()); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>src</span>.<span class='ident'>callbacks</span>.<span class='ident'>len</span>(), <span class='number'>0</span>); + } +} +</pre> +</section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <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>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "carboxyl"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |