diff options
Diffstat (limited to 'src/carboxyl')
| -rw-r--r-- | src/carboxyl/lib.rs.html | 419 | ||||
| -rw-r--r-- | src/carboxyl/lift.rs.html | 605 | ||||
| -rw-r--r-- | src/carboxyl/pending.rs.html | 271 | ||||
| -rw-r--r-- | src/carboxyl/readonly.rs.html | 173 | ||||
| -rw-r--r-- | src/carboxyl/signal.rs.html | 1601 | ||||
| -rw-r--r-- | src/carboxyl/source.rs.html | 359 | ||||
| -rw-r--r-- | src/carboxyl/stream.rs.html | 1645 | ||||
| -rw-r--r-- | src/carboxyl/transaction.rs.html | 459 |
8 files changed, 5532 insertions, 0 deletions
diff --git a/src/carboxyl/lib.rs.html b/src/carboxyl/lib.rs.html new file mode 100644 index 0000000..912fa0d --- /dev/null +++ b/src/carboxyl/lib.rs.html @@ -0,0 +1,419 @@ +<!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/lib.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lib.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> +<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> +</pre><pre class='rust '> +<span class='doccomment'>//! *Carboxyl* provides primitives for functional reactive programming in Rust.</span> +<span class='doccomment'>//! It draws inspiration from the [Sodium][sodium] libraries and Push-Pull FRP,</span> +<span class='doccomment'>//! as described by [Elliott (2009)][elliott_push_pull].</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! [sodium]: https://github.com/SodiumFRP/sodium/</span> +<span class='doccomment'>//! [elliott_push_pull]: http://conal.net/papers/push-pull-frp/push-pull-frp.pdf</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Overview</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Functional reactive programming (FRP) is a composable and modular</span> +<span class='doccomment'>//! abstraction for creating dynamic and reactive systems. In its most general</span> +<span class='doccomment'>//! form it models these systems as a composition of two basic primitives:</span> +<span class='doccomment'>//! *streams* are a series of singular events and *signals* are continuously</span> +<span class='doccomment'>//! changing values.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! *Carboxyl* is an imperative, hybrid push- and pull-based implementation of</span> +<span class='doccomment'>//! FRP. Streams and the discrete components of signals are data-driven, i.e.</span> +<span class='doccomment'>//! whenever an event occurs the resulting changes are propagated to everything</span> +<span class='doccomment'>//! that depends on it.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! However, the continuous components of signals are demand-driven. Internally,</span> +<span class='doccomment'>//! *Carboxyl* stores the state of a signal as a function. This function has to</span> +<span class='doccomment'>//! be evaluated by consumers of a signal to obtain a concrete value.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Nonetheless, *Carboxyl* has no explicit notion of time. Its signals are</span> +<span class='doccomment'>//! functions that can be evaluated at any time, but they do not carry any</span> +<span class='doccomment'>//! inherent notion of time. Synchronization and atomicity is achieved by a</span> +<span class='doccomment'>//! transaction system.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Functional reactive primitives</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! This library provides two basic types: `Stream` and `Signal`. A stream is a</span> +<span class='doccomment'>//! discrete sequence of events, a signal is a container for values that change</span> +<span class='doccomment'>//! (discretely) over time.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! The FRP primitives are mostly implemented as methods of the basic types to</span> +<span class='doccomment'>//! ease method chaining, except for the various lifting functions, as they do</span> +<span class='doccomment'>//! not really belong to any type in particular.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! In addition, the `Sink` type allows one to create a stream of events by</span> +<span class='doccomment'>//! sending values into it. It is the only way to create a stream from scratch,</span> +<span class='doccomment'>//! i.e. without using any of the other primitives.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Usage example</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Here is a simple example of how you can use the primitives provided by</span> +<span class='doccomment'>//! *Carboxyl*. First of all, events can be sent into a *sink*. From a sink one</span> +<span class='doccomment'>//! can create a *stream* of events. Streams can also be filtered, mapped and</span> +<span class='doccomment'>//! merged. One can e.g. hold the last event from a stream as a signal.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//! use carboxyl::Sink;</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! let sink = Sink::new();</span> +<span class='doccomment'>//! let stream = sink.stream();</span> +<span class='doccomment'>//! let signal = stream.hold(3);</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! // The current value of the signal is initially 3</span> +<span class='doccomment'>//! assert_eq!(signal.sample(), 3);</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! // When we fire an event, the signal get updated accordingly</span> +<span class='doccomment'>//! sink.send(5);</span> +<span class='doccomment'>//! assert_eq!(signal.sample(), 5);</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! One can also directly iterate over the stream instead of holding it in a</span> +<span class='doccomment'>//! signal:</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//! # use carboxyl::Sink;</span> +<span class='doccomment'>//! # let sink = Sink::new();</span> +<span class='doccomment'>//! # let stream = sink.stream();</span> +<span class='doccomment'>//! let mut events = stream.events();</span> +<span class='doccomment'>//! sink.send(4);</span> +<span class='doccomment'>//! assert_eq!(events.next(), Some(4));</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Streams and signals can be combined using various primitives. We can map a</span> +<span class='doccomment'>//! stream to another stream using a function:</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//! # use carboxyl::Sink;</span> +<span class='doccomment'>//! # let sink: Sink<i32> = Sink::new();</span> +<span class='doccomment'>//! # let stream = sink.stream();</span> +<span class='doccomment'>//! let squares = stream.map(|x| x * x).hold(0);</span> +<span class='doccomment'>//! sink.send(4);</span> +<span class='doccomment'>//! assert_eq!(squares.sample(), 16);</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Or we can filter a stream to create a new one that only contains events that</span> +<span class='doccomment'>//! satisfy a certain predicate:</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//! # use carboxyl::Sink;</span> +<span class='doccomment'>//! # let sink: Sink<i32> = Sink::new();</span> +<span class='doccomment'>//! # let stream = sink.stream();</span> +<span class='doccomment'>//! let negatives = stream.filter(|&x| x < 0).hold(0);</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! // This won't arrive at the signal.</span> +<span class='doccomment'>//! sink.send(4);</span> +<span class='doccomment'>//! assert_eq!(negatives.sample(), 0);</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! // But this will!</span> +<span class='doccomment'>//! sink.send(-3);</span> +<span class='doccomment'>//! assert_eq!(negatives.sample(), -3);</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! There are some other methods on streams and signals, that you can find in</span> +<span class='doccomment'>//! their respective APIs.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Note that all these objects are `Send + Sync + Clone`. This means you can</span> +<span class='doccomment'>//! easily pass them around in your code, make clones, give them to another</span> +<span class='doccomment'>//! thread, and they will still be updated correctly.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! You may have noticed that certain primitives take a function as an argument.</span> +<span class='doccomment'>//! There is a limitation on what kind of functions can and should be used here.</span> +<span class='doccomment'>//! In general, as FRP provides an abstraction around mutable state, they should</span> +<span class='doccomment'>//! be pure functions (i.e. free of side effects).</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! For the most part this is guaranteed by Rust's type system. A static</span> +<span class='doccomment'>//! function with a matching signature always works. A closure though is very</span> +<span class='doccomment'>//! restricted: it must not borrow its environment, as it is impossible to</span> +<span class='doccomment'>//! satisfy the lifetime requirements for that. So you can only move stuff into</span> +<span class='doccomment'>//! it from the environment. However, the moved contents of the closure may also</span> +<span class='doccomment'>//! not be altered, which is guaranteed by the `Fn(…) -> …)` trait bound.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! However, both closures and functions could still have side effects such as</span> +<span class='doccomment'>//! I/O, changing mutable state via `Mutex` or `RefCell`, etc. While Rust's type</span> +<span class='doccomment'>//! system cannot prevent this, you should generally not pass such functions to</span> +<span class='doccomment'>//! the FRP primitives, as they break the benefits you get from using FRP.</span> +<span class='doccomment'>//! (An exception here is debugging output.)</span> + +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>feature</span>(<span class='ident'>arc_weak</span>, <span class='ident'>fnbox</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>cfg_attr</span>(<span class='ident'>test</span>, <span class='ident'>feature</span>(<span class='ident'>test</span>, <span class='ident'>scoped</span>))]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>warn</span>(<span class='ident'>missing_docs</span>)]</span> + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>test</span>; +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>rand</span>; +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>quickcheck</span>; +<span class='attribute'>#[<span class='ident'>macro_use</span>(<span class='ident'>lazy_static</span>)]</span> +<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>lazy_static</span>; + +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>stream</span>::{ <span class='ident'>Sink</span>, <span class='ident'>Stream</span> }; +<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>signal</span>::{ <span class='ident'>Signal</span>, <span class='ident'>SignalMut</span> }; + +<span class='kw'>mod</span> <span class='ident'>transaction</span>; +<span class='kw'>mod</span> <span class='ident'>source</span>; +<span class='kw'>mod</span> <span class='ident'>pending</span>; +<span class='kw'>mod</span> <span class='ident'>readonly</span>; +<span class='kw'>mod</span> <span class='ident'>stream</span>; +<span class='kw'>mod</span> <span class='ident'>signal</span>; +<span class='attribute'>#[<span class='ident'>macro_use</span>]</span> +<span class='kw'>pub</span> <span class='kw'>mod</span> <span class='ident'>lift</span>; +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>mod</span> <span class='ident'>testing</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 diff --git a/src/carboxyl/lift.rs.html b/src/carboxyl/lift.rs.html new file mode 100644 index 0000000..224dbe8 --- /dev/null +++ b/src/carboxyl/lift.rs.html @@ -0,0 +1,605 @@ +<!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/lift.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lift.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> +<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> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +<span id="192">192</span> +<span id="193">193</span> +<span id="194">194</span> +<span id="195">195</span> +<span id="196">196</span> +<span id="197">197</span> +<span id="198">198</span> +<span id="199">199</span> +<span id="200">200</span> +<span id="201">201</span> +<span id="202">202</span> +<span id="203">203</span> +<span id="204">204</span> +<span id="205">205</span> +<span id="206">206</span> +<span id="207">207</span> +<span id="208">208</span> +<span id="209">209</span> +<span id="210">210</span> +<span id="211">211</span> +<span id="212">212</span> +<span id="213">213</span> +<span id="214">214</span> +<span id="215">215</span> +<span id="216">216</span> +<span id="217">217</span> +<span id="218">218</span> +<span id="219">219</span> +<span id="220">220</span> +<span id="221">221</span> +<span id="222">222</span> +<span id="223">223</span> +<span id="224">224</span> +<span id="225">225</span> +<span id="226">226</span> +<span id="227">227</span> +<span id="228">228</span> +<span id="229">229</span> +<span id="230">230</span> +<span id="231">231</span> +<span id="232">232</span> +<span id="233">233</span> +<span id="234">234</span> +<span id="235">235</span> +<span id="236">236</span> +<span id="237">237</span> +<span id="238">238</span> +<span id="239">239</span> +<span id="240">240</span> +<span id="241">241</span> +<span id="242">242</span> +<span id="243">243</span> +<span id="244">244</span> +<span id="245">245</span> +<span id="246">246</span> +<span id="247">247</span> +<span id="248">248</span> +<span id="249">249</span> +<span id="250">250</span> +<span id="251">251</span> +<span id="252">252</span> +<span id="253">253</span> +<span id="254">254</span> +</pre><pre class='rust '> +<span class='doccomment'>//! Lifting of n-ary functions.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! A lift maps a function on values to a function on signals. Given a function of</span> +<span class='doccomment'>//! type `F: Fn(A, B, …) -> R` and signals of types `Signal<A>, Signal<B>, …` the</span> +<span class='doccomment'>//! `lift!` macro creates a `Signal<R>`, whose content is computed using the</span> +<span class='doccomment'>//! function.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! Currently lift is only implemented for functions with up to four arguments.</span> +<span class='doccomment'>//! This limitation is due to the current implementation strategy (and maybe</span> +<span class='doccomment'>//! limitations of Rust's type system), but it can be increased to arbitrary but</span> +<span class='doccomment'>//! finite arity if required.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! # Example</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! ```</span> +<span class='doccomment'>//! # #[macro_use] extern crate carboxyl;</span> +<span class='doccomment'>//! # fn main() {</span> +<span class='doccomment'>//! # use carboxyl::Sink;</span> +<span class='doccomment'>//! let sink_a = Sink::new();</span> +<span class='doccomment'>//! let sink_b = Sink::new();</span> +<span class='doccomment'>//! let product = lift!(</span> +<span class='doccomment'>//! |a, b| a * b,</span> +<span class='doccomment'>//! &sink_a.stream().hold(0),</span> +<span class='doccomment'>//! &sink_b.stream().hold(0)</span> +<span class='doccomment'>//! );</span> +<span class='doccomment'>//! assert_eq!(product.sample(), 0);</span> +<span class='doccomment'>//! sink_a.send(3);</span> +<span class='doccomment'>//! sink_b.send(5);</span> +<span class='doccomment'>//! assert_eq!(product.sample(), 15);</span> +<span class='doccomment'>//! # }</span> +<span class='doccomment'>//! ```</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>Arc</span>; +<span class='kw'>use</span> <span class='ident'>signal</span>::{ <span class='ident'>Signal</span>, <span class='ident'>SignalFn</span>, <span class='ident'>signal_build</span>, <span class='ident'>signal_current</span>, <span class='ident'>signal_source</span>, <span class='ident'>reg_signal</span>, <span class='ident'>sample_raw</span> }; +<span class='kw'>use</span> <span class='ident'>transaction</span>::<span class='ident'>commit</span>; + + +<span class='attribute'>#[<span class='ident'>macro_export</span>]</span> +<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>lift</span> { + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>: <span class='ident'>expr</span>) + <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>lift</span>::<span class='ident'>lift0</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>) ); + + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>: <span class='ident'>expr</span>) + <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>lift</span>::<span class='ident'>lift1</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>) ); + + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>: <span class='ident'>expr</span>) + <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>lift</span>::<span class='ident'>lift2</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>) ); + + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>c</span>: <span class='ident'>expr</span>) + <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>lift</span>::<span class='ident'>lift3</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>c</span>) ); + + (<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>c</span>: <span class='ident'>expr</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>d</span>: <span class='ident'>expr</span>) + <span class='op'>=></span> ( <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>crate</span>::<span class='ident'>lift</span>::<span class='ident'>lift4</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>f</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>a</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>b</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>c</span>, <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>d</span>) ); +} + + +<span class='doccomment'>/// Lift a 0-ary function.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>lift0</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>Fn</span>() <span class='op'>-></span> <span class='ident'>A</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='ident'>commit</span>(<span class='op'>||</span> <span class='ident'>signal_build</span>(<span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='ident'>f</span>), ())) +} + + +<span class='doccomment'>/// Lift a unary function.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>lift1</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='ident'>F</span>, <span class='ident'>sa</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</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='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>B</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='kw'>fn</span> <span class='ident'>make_callback</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>, <span class='ident'>parent</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</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='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>B</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='kw'>let</span> <span class='ident'>pclone</span> <span class='op'>=</span> <span class='ident'>parent</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>f</span> <span class='op'>=</span> <span class='ident'>f</span>.<span class='ident'>clone</span>(); + <span class='kw'>match</span> <span class='op'>*</span><span class='ident'>signal_current</span>(<span class='kw-2'>&</span><span class='ident'>parent</span>).<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>future</span>() { + <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>) <span class='op'>=></span> <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>f</span>(<span class='ident'>a</span>.<span class='ident'>clone</span>())), + <span class='ident'>SignalFn</span>::<span class='ident'>Func</span>(_) <span class='op'>=></span> <span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>f</span>(<span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>pclone</span>))), + } + } + + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>f</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>f</span>); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>signal_build</span>(<span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>sa</span>), ()); + <span class='kw'>let</span> <span class='ident'>sa_clone</span> <span class='op'>=</span> <span class='ident'>sa</span>.<span class='ident'>clone</span>(); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>signal_source</span>(<span class='kw-2'>&</span><span class='ident'>sa</span>).<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, + <span class='kw'>move</span> <span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>sa_clone</span>)); + <span class='ident'>signal</span> + }) +} + + +<span class='doccomment'>/// Lift a binary function.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>lift2</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='ident'>F</span>, <span class='ident'>sa</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>sb</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</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='ident'>B</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='ident'>C</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='kw'>fn</span> <span class='ident'>make_callback</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>, <span class='ident'>sa</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>sb</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</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='ident'>B</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='ident'>C</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='kw'>use</span> <span class='ident'>signal</span>::<span class='ident'>SignalFn</span>::{ <span class='ident'>Const</span>, <span class='ident'>Func</span> }; + <span class='kw'>let</span> <span class='ident'>sa_clone</span> <span class='op'>=</span> <span class='ident'>sa</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>sb_clone</span> <span class='op'>=</span> <span class='ident'>sb</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>f</span> <span class='op'>=</span> <span class='ident'>f</span>.<span class='ident'>clone</span>(); + <span class='kw'>match</span> ( + <span class='ident'>signal_current</span>(<span class='kw-2'>&</span><span class='ident'>sa</span>).<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>future</span>(), + <span class='ident'>signal_current</span>(<span class='kw-2'>&</span><span class='ident'>sb</span>).<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>future</span>(), + ) { + (<span class='kw-2'>&</span><span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>), <span class='kw-2'>&</span><span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>b</span>)) <span class='op'>=></span> <span class='ident'>Const</span>(<span class='ident'>f</span>(<span class='ident'>a</span>.<span class='ident'>clone</span>(), <span class='ident'>b</span>.<span class='ident'>clone</span>())), + (<span class='kw-2'>&</span><span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>), <span class='kw-2'>&</span><span class='ident'>Func</span>(_)) <span class='op'>=></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'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>f</span>(<span class='ident'>a</span>.<span class='ident'>clone</span>(), <span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>sb_clone</span>))) + }, + (<span class='kw-2'>&</span><span class='ident'>Func</span>(_), <span class='kw-2'>&</span><span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>b</span>)) <span class='op'>=></span> { + <span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>b</span>.<span class='ident'>clone</span>(); + <span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>f</span>(<span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>sa_clone</span>), <span class='ident'>b</span>.<span class='ident'>clone</span>())) + }, + (<span class='kw-2'>&</span><span class='ident'>Func</span>(_), <span class='kw-2'>&</span><span class='ident'>Func</span>(_)) <span class='op'>=></span> <span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>( + <span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>f</span>(<span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>sa_clone</span>), <span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>sb_clone</span>)) + ), + } + } + + <span class='ident'>commit</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>f</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>f</span>); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>signal_build</span>(<span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>sa</span>, <span class='kw-2'>&</span><span class='ident'>sb</span>), ()); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>signal_source</span>(<span class='kw-2'>&</span><span class='ident'>sa</span>).<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, { + <span class='kw'>let</span> <span class='ident'>sa_clone</span> <span class='op'>=</span> <span class='ident'>sa</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>sb_clone</span> <span class='op'>=</span> <span class='ident'>sb</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>f</span> <span class='op'>=</span> <span class='ident'>f</span>.<span class='ident'>clone</span>(); + <span class='kw'>move</span> <span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>sa_clone</span>, <span class='kw-2'>&</span><span class='ident'>sb_clone</span>) + }); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>signal_source</span>(<span class='kw-2'>&</span><span class='ident'>sb</span>).<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, { + <span class='kw'>let</span> <span class='ident'>sa_clone</span> <span class='op'>=</span> <span class='ident'>sa</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>sb_clone</span> <span class='op'>=</span> <span class='ident'>sb</span>.<span class='ident'>clone</span>(); + <span class='kw'>move</span> <span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>sa_clone</span>, <span class='kw-2'>&</span><span class='ident'>sb_clone</span>) + }); + <span class='ident'>signal</span> + }) +} + +<span class='doccomment'>/// Lift a ternary function.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>lift3</span><span class='op'><</span><span class='ident'>F</span>, <span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>Ret</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='ident'>F</span>, <span class='ident'>ca</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>cb</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>cc</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span>) + <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>Ret</span><span class='op'>></span> +<span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>) <span class='op'>-></span> <span class='ident'>Ret</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='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='ident'>B</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='ident'>C</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='ident'>Ret</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='ident'>lift2</span>(<span class='kw'>move</span> <span class='op'>|</span>(<span class='ident'>a</span>, <span class='ident'>b</span>), <span class='ident'>c</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='ident'>a</span>, <span class='ident'>b</span>, <span class='ident'>c</span>), <span class='kw-2'>&</span><span class='ident'>lift2</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>), <span class='ident'>ca</span>, <span class='ident'>cb</span>), <span class='ident'>cc</span>) +} + +<span class='doccomment'>/// Lift a quarternary function.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>lift4</span><span class='op'><</span><span class='ident'>F</span>, <span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>D</span>, <span class='ident'>Ret</span><span class='op'>></span>(<span class='ident'>f</span>: <span class='ident'>F</span>, <span class='ident'>ca</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>cb</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>cc</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span>, <span class='ident'>cd</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>D</span><span class='op'>></span>) + <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>Ret</span><span class='op'>></span> +<span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>D</span>) <span class='op'>-></span> <span class='ident'>Ret</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='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='ident'>B</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='ident'>C</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='ident'>D</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='ident'>Ret</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='ident'>lift2</span>( + <span class='kw'>move</span> <span class='op'>|</span>(<span class='ident'>a</span>, <span class='ident'>b</span>), (<span class='ident'>c</span>, <span class='ident'>d</span>)<span class='op'>|</span> <span class='ident'>f</span>(<span class='ident'>a</span>, <span class='ident'>b</span>, <span class='ident'>c</span>, <span class='ident'>d</span>), + <span class='kw-2'>&</span><span class='ident'>lift2</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>), <span class='ident'>ca</span>, <span class='ident'>cb</span>), + <span class='kw-2'>&</span><span class='ident'>lift2</span>(<span class='op'>|</span><span class='ident'>c</span>, <span class='ident'>d</span><span class='op'>|</span> (<span class='ident'>c</span>, <span class='ident'>d</span>), <span class='ident'>cc</span>, <span class='ident'>cd</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'>stream</span>::<span class='ident'>Sink</span>; + <span class='kw'>use</span> <span class='ident'>signal</span>::<span class='ident'>Signal</span>; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift0</span>() { + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>||</span> <span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>signal</span>.<span class='ident'>sample</span>(), <span class='number'>3</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift1</span>() { + <span class='kw'>let</span> <span class='ident'>sig2</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>n</span><span class='op'>|</span> <span class='ident'>n</span> <span class='op'>+</span> <span class='number'>2</span>, <span class='kw-2'>&</span><span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='number'>3</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>sig2</span>.<span class='ident'>sample</span>(), <span class='number'>5</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift2</span>() { + <span class='kw'>let</span> <span class='ident'>sink1</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink2</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>lifted</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>a</span> <span class='op'>+</span> <span class='ident'>b</span>, <span class='kw-2'>&</span><span class='ident'>sink1</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>0</span>), + <span class='kw-2'>&</span><span class='ident'>sink2</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>3</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>lifted</span>.<span class='ident'>sample</span>(), <span class='number'>3</span>); + <span class='ident'>sink1</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>lifted</span>.<span class='ident'>sample</span>(), <span class='number'>4</span>); + <span class='ident'>sink2</span>.<span class='ident'>send</span>(<span class='number'>11</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>lifted</span>.<span class='ident'>sample</span>(), <span class='number'>12</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift2_identical</span>() { + <span class='kw'>let</span> <span class='ident'>sig</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='number'>16</span>); + <span class='kw'>let</span> <span class='ident'>sig2</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>a</span> <span class='op'>+</span> <span class='ident'>b</span>, <span class='kw-2'>&</span><span class='ident'>sig</span>, <span class='kw-2'>&</span><span class='ident'>sig</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>sig2</span>.<span class='ident'>sample</span>(), <span class='number'>32</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift3</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>( + <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>x</span>, <span class='ident'>y</span>, <span class='ident'>z</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'>+</span> <span class='number'>2</span> <span class='op'>*</span> <span class='ident'>y</span> <span class='op'>+</span> <span class='ident'>z</span>, + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>5</span>), + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>3</span>), + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='op'>-</span><span class='number'>4</span>) + ).<span class='ident'>sample</span>(), + <span class='number'>7</span> + ); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift4</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>( + <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>w</span>, <span class='ident'>x</span>, <span class='ident'>y</span>, <span class='ident'>z</span><span class='op'>|</span> <span class='number'>4</span> <span class='op'>*</span> <span class='ident'>w</span> <span class='op'>+</span> <span class='ident'>x</span> <span class='op'>+</span> <span class='number'>2</span> <span class='op'>*</span> <span class='ident'>y</span> <span class='op'>+</span> <span class='ident'>z</span>, + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='op'>-</span><span class='number'>2</span>), + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>5</span>), + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>3</span>), + <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='op'>-</span><span class='number'>4</span>) + ).<span class='ident'>sample</span>(), + <span class='op'>-</span><span class='number'>1</span> + ); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>lift0_equal_within_transaction</span>() { + <span class='kw'>use</span> <span class='ident'>rand</span>::<span class='ident'>random</span>; + <span class='comment'>// Generate a completely random signal</span> + <span class='kw'>let</span> <span class='ident'>rnd</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='ident'>random</span>::<span class='op'><</span><span class='ident'>i64</span><span class='op'>></span>); + <span class='comment'>// Make a tuple with itself</span> + <span class='kw'>let</span> <span class='ident'>gather</span> <span class='op'>=</span> <span class='macro'>lift</span><span class='macro'>!</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>), <span class='kw-2'>&</span><span class='ident'>rnd</span>, <span class='kw-2'>&</span><span class='ident'>rnd</span>); + <span class='comment'>// Both components should be equal</span> + <span class='kw'>let</span> (<span class='ident'>a</span>, <span class='ident'>b</span>) <span class='op'>=</span> <span class='ident'>gather</span>.<span class='ident'>sample</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>a</span>, <span class='ident'>b</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 diff --git a/src/carboxyl/pending.rs.html b/src/carboxyl/pending.rs.html new file mode 100644 index 0000000..6e0f11f --- /dev/null +++ b/src/carboxyl/pending.rs.html @@ -0,0 +1,271 @@ +<!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/pending.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>pending.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> +</pre><pre class='rust '> +<span class='doccomment'>//! Pending wrapper</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Deref</span>; + + +<span class='doccomment'>/// A pending value. This is a wrapper type that allows one to queue one new</span> +<span class='doccomment'>/// value without actually overwriting the old value. Later the most recently</span> +<span class='doccomment'>/// queued value can be updated.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Pending</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='ident'>current</span>: <span class='ident'>T</span>, + <span class='ident'>update</span>: <span class='prelude-ty'>Option</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'>T</span><span class='op'>></span> <span class='ident'>Pending</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='doccomment'>/// Create a new pending value.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>t</span>: <span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>Pending</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='ident'>Pending</span> { <span class='ident'>current</span>: <span class='ident'>t</span>, <span class='ident'>update</span>: <span class='prelude-val'>None</span> } + } + + <span class='doccomment'>/// Put an item in the queue. Ignores any previously queued items.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>queue</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>new</span>: <span class='ident'>T</span>) { + <span class='self'>self</span>.<span class='ident'>update</span> <span class='op'>=</span> <span class='prelude-val'>Some</span>(<span class='ident'>new</span>); + } + + <span class='doccomment'>/// Updates any update pending.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>update</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) { + <span class='kw'>if</span> <span class='kw'>let</span> <span class='prelude-val'>Some</span>(<span class='ident'>t</span>) <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>update</span>.<span class='ident'>take</span>() { + <span class='self'>self</span>.<span class='ident'>current</span> <span class='op'>=</span> <span class='ident'>t</span>; + } + } + + <span class='doccomment'>/// Get the future value.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>future</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>T</span> { + <span class='self'>self</span>.<span class='ident'>update</span>.<span class='ident'>as_ref</span>().<span class='ident'>unwrap_or</span>(<span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>current</span>) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>Pending</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>T</span>; + <span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>T</span> { <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>current</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'>super</span>::<span class='op'>*</span>; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>new_derefs_identical</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='number'>3</span>), <span class='number'>3</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>queue_does_not_affect_deref</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='number'>2</span>); + <span class='ident'>p</span>.<span class='ident'>queue</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>p</span>, <span class='number'>2</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>new_future_identical</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='number'>5</span>).<span class='ident'>future</span>(), <span class='number'>5</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>queue_affects_future</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='number'>10</span>); + <span class='ident'>p</span>.<span class='ident'>queue</span>(<span class='number'>6</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>p</span>.<span class='ident'>future</span>(), <span class='number'>6</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>updated_deref</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='op'>-</span><span class='number'>2</span>); + <span class='ident'>p</span>.<span class='ident'>queue</span>(<span class='number'>2</span>); + <span class='ident'>p</span>.<span class='ident'>update</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>p</span>, <span class='number'>2</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>updated_future</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='op'>-</span><span class='number'>7</span>); + <span class='ident'>p</span>.<span class='ident'>queue</span>(<span class='number'>0</span>); + <span class='ident'>p</span>.<span class='ident'>update</span>(); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>p</span>.<span class='ident'>future</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 diff --git a/src/carboxyl/readonly.rs.html b/src/carboxyl/readonly.rs.html new file mode 100644 index 0000000..84fce7f --- /dev/null +++ b/src/carboxyl/readonly.rs.html @@ -0,0 +1,173 @@ +<!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/readonly.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>readonly.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> +</pre><pre class='rust '> +<span class='doccomment'>//! Thread-safe read-only smart pointer.</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='ident'>RwLockReadGuard</span> }; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Deref</span>; + +<span class='doccomment'>/// Guards read-access into a read-only pointer.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ReadOnlyGuard</span><span class='op'><</span><span class='lifetime'>'a</span>, <span class='ident'>T</span>: <span class='lifetime'>'a</span><span class='op'>></span> { + <span class='ident'>guard</span>: <span class='ident'>RwLockReadGuard</span><span class='op'><</span><span class='lifetime'>'a</span>, <span class='ident'>T</span><span class='op'>></span>, +} + +<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span>, <span class='ident'>T</span><span class='op'>></span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>ReadOnlyGuard</span><span class='op'><</span><span class='lifetime'>'a</span>, <span class='ident'>T</span><span class='op'>></span> { + <span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>T</span>; + <span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>T</span> { <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>guard</span> } +} + +<span class='doccomment'>/// A thread-safe read-only smart pointer.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ReadOnly</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='ident'>ptr</span>: <span class='ident'>Arc</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='kw'>impl</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='ident'>Clone</span> <span class='kw'>for</span> <span class='ident'>ReadOnly</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>ReadOnly</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='ident'>ReadOnly</span> { <span class='ident'>ptr</span>: <span class='self'>self</span>.<span class='ident'>ptr</span>.<span class='ident'>clone</span>() } + } +} + +<span class='doccomment'>/// Create a new read-only pointer.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>create</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span>(<span class='ident'>ptr</span>: <span class='ident'>Arc</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='op'>-></span> <span class='ident'>ReadOnly</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { <span class='ident'>ReadOnly</span> { <span class='ident'>ptr</span>: <span class='ident'>ptr</span> } } + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='ident'>ReadOnly</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> { + <span class='doccomment'>/// Gain read-access to the stored value.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// In case, the underlying data structure has been poisoned, it returns</span> + <span class='doccomment'>/// `None`.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>read</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>ReadOnlyGuard</span><span class='op'><</span><span class='ident'>T</span><span class='op'>>></span> { + <span class='self'>self</span>.<span class='ident'>ptr</span>.<span class='ident'>read</span>().<span class='ident'>ok</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>g</span><span class='op'>|</span> <span class='ident'>ReadOnlyGuard</span> { <span class='ident'>guard</span>: <span class='ident'>g</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 diff --git a/src/carboxyl/signal.rs.html b/src/carboxyl/signal.rs.html new file mode 100644 index 0000000..659a0a7 --- /dev/null +++ b/src/carboxyl/signal.rs.html @@ -0,0 +1,1601 @@ +<!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/signal.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>signal.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> +<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> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +<span id="192">192</span> +<span id="193">193</span> +<span id="194">194</span> +<span id="195">195</span> +<span id="196">196</span> +<span id="197">197</span> +<span id="198">198</span> +<span id="199">199</span> +<span id="200">200</span> +<span id="201">201</span> +<span id="202">202</span> +<span id="203">203</span> +<span id="204">204</span> +<span id="205">205</span> +<span id="206">206</span> +<span id="207">207</span> +<span id="208">208</span> +<span id="209">209</span> +<span id="210">210</span> +<span id="211">211</span> +<span id="212">212</span> +<span id="213">213</span> +<span id="214">214</span> +<span id="215">215</span> +<span id="216">216</span> +<span id="217">217</span> +<span id="218">218</span> +<span id="219">219</span> +<span id="220">220</span> +<span id="221">221</span> +<span id="222">222</span> +<span id="223">223</span> +<span id="224">224</span> +<span id="225">225</span> +<span id="226">226</span> +<span id="227">227</span> +<span id="228">228</span> +<span id="229">229</span> +<span id="230">230</span> +<span id="231">231</span> +<span id="232">232</span> +<span id="233">233</span> +<span id="234">234</span> +<span id="235">235</span> +<span id="236">236</span> +<span id="237">237</span> +<span id="238">238</span> +<span id="239">239</span> +<span id="240">240</span> +<span id="241">241</span> +<span id="242">242</span> +<span id="243">243</span> +<span id="244">244</span> +<span id="245">245</span> +<span id="246">246</span> +<span id="247">247</span> +<span id="248">248</span> +<span id="249">249</span> +<span id="250">250</span> +<span id="251">251</span> +<span id="252">252</span> +<span id="253">253</span> +<span id="254">254</span> +<span id="255">255</span> +<span id="256">256</span> +<span id="257">257</span> +<span id="258">258</span> +<span id="259">259</span> +<span id="260">260</span> +<span id="261">261</span> +<span id="262">262</span> +<span id="263">263</span> +<span id="264">264</span> +<span id="265">265</span> +<span id="266">266</span> +<span id="267">267</span> +<span id="268">268</span> +<span id="269">269</span> +<span id="270">270</span> +<span id="271">271</span> +<span id="272">272</span> +<span id="273">273</span> +<span id="274">274</span> +<span id="275">275</span> +<span id="276">276</span> +<span id="277">277</span> +<span id="278">278</span> +<span id="279">279</span> +<span id="280">280</span> +<span id="281">281</span> +<span id="282">282</span> +<span id="283">283</span> +<span id="284">284</span> +<span id="285">285</span> +<span id="286">286</span> +<span id="287">287</span> +<span id="288">288</span> +<span id="289">289</span> +<span id="290">290</span> +<span id="291">291</span> +<span id="292">292</span> +<span id="293">293</span> +<span id="294">294</span> +<span id="295">295</span> +<span id="296">296</span> +<span id="297">297</span> +<span id="298">298</span> +<span id="299">299</span> +<span id="300">300</span> +<span id="301">301</span> +<span id="302">302</span> +<span id="303">303</span> +<span id="304">304</span> +<span id="305">305</span> +<span id="306">306</span> +<span id="307">307</span> +<span id="308">308</span> +<span id="309">309</span> +<span id="310">310</span> +<span id="311">311</span> +<span id="312">312</span> +<span id="313">313</span> +<span id="314">314</span> +<span id="315">315</span> +<span id="316">316</span> +<span id="317">317</span> +<span id="318">318</span> +<span id="319">319</span> +<span id="320">320</span> +<span id="321">321</span> +<span id="322">322</span> +<span id="323">323</span> +<span id="324">324</span> +<span id="325">325</span> +<span id="326">326</span> +<span id="327">327</span> +<span id="328">328</span> +<span id="329">329</span> +<span id="330">330</span> +<span id="331">331</span> +<span id="332">332</span> +<span id="333">333</span> +<span id="334">334</span> +<span id="335">335</span> +<span id="336">336</span> +<span id="337">337</span> +<span id="338">338</span> +<span id="339">339</span> +<span id="340">340</span> +<span id="341">341</span> +<span id="342">342</span> +<span id="343">343</span> +<span id="344">344</span> +<span id="345">345</span> +<span id="346">346</span> +<span id="347">347</span> +<span id="348">348</span> +<span id="349">349</span> +<span id="350">350</span> +<span id="351">351</span> +<span id="352">352</span> +<span id="353">353</span> +<span id="354">354</span> +<span id="355">355</span> +<span id="356">356</span> +<span id="357">357</span> +<span id="358">358</span> +<span id="359">359</span> +<span id="360">360</span> +<span id="361">361</span> +<span id="362">362</span> +<span id="363">363</span> +<span id="364">364</span> +<span id="365">365</span> +<span id="366">366</span> +<span id="367">367</span> +<span id="368">368</span> +<span id="369">369</span> +<span id="370">370</span> +<span id="371">371</span> +<span id="372">372</span> +<span id="373">373</span> +<span id="374">374</span> +<span id="375">375</span> +<span id="376">376</span> +<span id="377">377</span> +<span id="378">378</span> +<span id="379">379</span> +<span id="380">380</span> +<span id="381">381</span> +<span id="382">382</span> +<span id="383">383</span> +<span id="384">384</span> +<span id="385">385</span> +<span id="386">386</span> +<span id="387">387</span> +<span id="388">388</span> +<span id="389">389</span> +<span id="390">390</span> +<span id="391">391</span> +<span id="392">392</span> +<span id="393">393</span> +<span id="394">394</span> +<span id="395">395</span> +<span id="396">396</span> +<span id="397">397</span> +<span id="398">398</span> +<span id="399">399</span> +<span id="400">400</span> +<span id="401">401</span> +<span id="402">402</span> +<span id="403">403</span> +<span id="404">404</span> +<span id="405">405</span> +<span id="406">406</span> +<span id="407">407</span> +<span id="408">408</span> +<span id="409">409</span> +<span id="410">410</span> +<span id="411">411</span> +<span id="412">412</span> +<span id="413">413</span> +<span id="414">414</span> +<span id="415">415</span> +<span id="416">416</span> +<span id="417">417</span> +<span id="418">418</span> +<span id="419">419</span> +<span id="420">420</span> +<span id="421">421</span> +<span id="422">422</span> +<span id="423">423</span> +<span id="424">424</span> +<span id="425">425</span> +<span id="426">426</span> +<span id="427">427</span> +<span id="428">428</span> +<span id="429">429</span> +<span id="430">430</span> +<span id="431">431</span> +<span id="432">432</span> +<span id="433">433</span> +<span id="434">434</span> +<span id="435">435</span> +<span id="436">436</span> +<span id="437">437</span> +<span id="438">438</span> +<span id="439">439</span> +<span id="440">440</span> +<span id="441">441</span> +<span id="442">442</span> +<span id="443">443</span> +<span id="444">444</span> +<span id="445">445</span> +<span id="446">446</span> +<span id="447">447</span> +<span id="448">448</span> +<span id="449">449</span> +<span id="450">450</span> +<span id="451">451</span> +<span id="452">452</span> +<span id="453">453</span> +<span id="454">454</span> +<span id="455">455</span> +<span id="456">456</span> +<span id="457">457</span> +<span id="458">458</span> +<span id="459">459</span> +<span id="460">460</span> +<span id="461">461</span> +<span id="462">462</span> +<span id="463">463</span> +<span id="464">464</span> +<span id="465">465</span> +<span id="466">466</span> +<span id="467">467</span> +<span id="468">468</span> +<span id="469">469</span> +<span id="470">470</span> +<span id="471">471</span> +<span id="472">472</span> +<span id="473">473</span> +<span id="474">474</span> +<span id="475">475</span> +<span id="476">476</span> +<span id="477">477</span> +<span id="478">478</span> +<span id="479">479</span> +<span id="480">480</span> +<span id="481">481</span> +<span id="482">482</span> +<span id="483">483</span> +<span id="484">484</span> +<span id="485">485</span> +<span id="486">486</span> +<span id="487">487</span> +<span id="488">488</span> +<span id="489">489</span> +<span id="490">490</span> +<span id="491">491</span> +<span id="492">492</span> +<span id="493">493</span> +<span id="494">494</span> +<span id="495">495</span> +<span id="496">496</span> +<span id="497">497</span> +<span id="498">498</span> +<span id="499">499</span> +<span id="500">500</span> +<span id="501">501</span> +<span id="502">502</span> +<span id="503">503</span> +<span id="504">504</span> +<span id="505">505</span> +<span id="506">506</span> +<span id="507">507</span> +<span id="508">508</span> +<span id="509">509</span> +<span id="510">510</span> +<span id="511">511</span> +<span id="512">512</span> +<span id="513">513</span> +<span id="514">514</span> +<span id="515">515</span> +<span id="516">516</span> +<span id="517">517</span> +<span id="518">518</span> +<span id="519">519</span> +<span id="520">520</span> +<span id="521">521</span> +<span id="522">522</span> +<span id="523">523</span> +<span id="524">524</span> +<span id="525">525</span> +<span id="526">526</span> +<span id="527">527</span> +<span id="528">528</span> +<span id="529">529</span> +<span id="530">530</span> +<span id="531">531</span> +<span id="532">532</span> +<span id="533">533</span> +<span id="534">534</span> +<span id="535">535</span> +<span id="536">536</span> +<span id="537">537</span> +<span id="538">538</span> +<span id="539">539</span> +<span id="540">540</span> +<span id="541">541</span> +<span id="542">542</span> +<span id="543">543</span> +<span id="544">544</span> +<span id="545">545</span> +<span id="546">546</span> +<span id="547">547</span> +<span id="548">548</span> +<span id="549">549</span> +<span id="550">550</span> +<span id="551">551</span> +<span id="552">552</span> +<span id="553">553</span> +<span id="554">554</span> +<span id="555">555</span> +<span id="556">556</span> +<span id="557">557</span> +<span id="558">558</span> +<span id="559">559</span> +<span id="560">560</span> +<span id="561">561</span> +<span id="562">562</span> +<span id="563">563</span> +<span id="564">564</span> +<span id="565">565</span> +<span id="566">566</span> +<span id="567">567</span> +<span id="568">568</span> +<span id="569">569</span> +<span id="570">570</span> +<span id="571">571</span> +<span id="572">572</span> +<span id="573">573</span> +<span id="574">574</span> +<span id="575">575</span> +<span id="576">576</span> +<span id="577">577</span> +<span id="578">578</span> +<span id="579">579</span> +<span id="580">580</span> +<span id="581">581</span> +<span id="582">582</span> +<span id="583">583</span> +<span id="584">584</span> +<span id="585">585</span> +<span id="586">586</span> +<span id="587">587</span> +<span id="588">588</span> +<span id="589">589</span> +<span id="590">590</span> +<span id="591">591</span> +<span id="592">592</span> +<span id="593">593</span> +<span id="594">594</span> +<span id="595">595</span> +<span id="596">596</span> +<span id="597">597</span> +<span id="598">598</span> +<span id="599">599</span> +<span id="600">600</span> +<span id="601">601</span> +<span id="602">602</span> +<span id="603">603</span> +<span id="604">604</span> +<span id="605">605</span> +<span id="606">606</span> +<span id="607">607</span> +<span id="608">608</span> +<span id="609">609</span> +<span id="610">610</span> +<span id="611">611</span> +<span id="612">612</span> +<span id="613">613</span> +<span id="614">614</span> +<span id="615">615</span> +<span id="616">616</span> +<span id="617">617</span> +<span id="618">618</span> +<span id="619">619</span> +<span id="620">620</span> +<span id="621">621</span> +<span id="622">622</span> +<span id="623">623</span> +<span id="624">624</span> +<span id="625">625</span> +<span id="626">626</span> +<span id="627">627</span> +<span id="628">628</span> +<span id="629">629</span> +<span id="630">630</span> +<span id="631">631</span> +<span id="632">632</span> +<span id="633">633</span> +<span id="634">634</span> +<span id="635">635</span> +<span id="636">636</span> +<span id="637">637</span> +<span id="638">638</span> +<span id="639">639</span> +<span id="640">640</span> +<span id="641">641</span> +<span id="642">642</span> +<span id="643">643</span> +<span id="644">644</span> +<span id="645">645</span> +<span id="646">646</span> +<span id="647">647</span> +<span id="648">648</span> +<span id="649">649</span> +<span id="650">650</span> +<span id="651">651</span> +<span id="652">652</span> +<span id="653">653</span> +<span id="654">654</span> +<span id="655">655</span> +<span id="656">656</span> +<span id="657">657</span> +<span id="658">658</span> +<span id="659">659</span> +<span id="660">660</span> +<span id="661">661</span> +<span id="662">662</span> +<span id="663">663</span> +<span id="664">664</span> +<span id="665">665</span> +<span id="666">666</span> +<span id="667">667</span> +<span id="668">668</span> +<span id="669">669</span> +<span id="670">670</span> +<span id="671">671</span> +<span id="672">672</span> +<span id="673">673</span> +<span id="674">674</span> +<span id="675">675</span> +<span id="676">676</span> +<span id="677">677</span> +<span id="678">678</span> +<span id="679">679</span> +<span id="680">680</span> +<span id="681">681</span> +<span id="682">682</span> +<span id="683">683</span> +<span id="684">684</span> +<span id="685">685</span> +<span id="686">686</span> +<span id="687">687</span> +<span id="688">688</span> +<span id="689">689</span> +<span id="690">690</span> +<span id="691">691</span> +<span id="692">692</span> +<span id="693">693</span> +<span id="694">694</span> +<span id="695">695</span> +<span id="696">696</span> +<span id="697">697</span> +<span id="698">698</span> +<span id="699">699</span> +<span id="700">700</span> +<span id="701">701</span> +<span id="702">702</span> +<span id="703">703</span> +<span id="704">704</span> +<span id="705">705</span> +<span id="706">706</span> +<span id="707">707</span> +<span id="708">708</span> +<span id="709">709</span> +<span id="710">710</span> +<span id="711">711</span> +<span id="712">712</span> +<span id="713">713</span> +<span id="714">714</span> +<span id="715">715</span> +<span id="716">716</span> +<span id="717">717</span> +<span id="718">718</span> +<span id="719">719</span> +<span id="720">720</span> +<span id="721">721</span> +<span id="722">722</span> +<span id="723">723</span> +<span id="724">724</span> +<span id="725">725</span> +<span id="726">726</span> +<span id="727">727</span> +<span id="728">728</span> +<span id="729">729</span> +<span id="730">730</span> +<span id="731">731</span> +<span id="732">732</span> +<span id="733">733</span> +<span id="734">734</span> +<span id="735">735</span> +<span id="736">736</span> +<span id="737">737</span> +<span id="738">738</span> +<span id="739">739</span> +<span id="740">740</span> +<span id="741">741</span> +<span id="742">742</span> +<span id="743">743</span> +<span id="744">744</span> +<span id="745">745</span> +<span id="746">746</span> +<span id="747">747</span> +<span id="748">748</span> +<span id="749">749</span> +<span id="750">750</span> +<span id="751">751</span> +<span id="752">752</span> +</pre><pre class='rust '> +<span class='doccomment'>//! Continuous time signals</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::{ <span class='ident'>Arc</span>, <span class='ident'>Mutex</span>, <span class='ident'>RwLock</span> }; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Deref</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>fmt</span>; +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>use</span> <span class='ident'>quickcheck</span>::{ <span class='ident'>Arbitrary</span>, <span class='ident'>Gen</span> }; + +<span class='kw'>use</span> <span class='ident'>source</span>::{ <span class='ident'>Source</span>, <span class='ident'>with_weak</span>, <span class='ident'>CallbackError</span> }; +<span class='kw'>use</span> <span class='ident'>stream</span>::{ <span class='self'>self</span>, <span class='ident'>BoxClone</span>, <span class='ident'>Stream</span> }; +<span class='kw'>use</span> <span class='ident'>transaction</span>::{ <span class='ident'>commit</span>, <span class='ident'>end</span> }; +<span class='kw'>use</span> <span class='ident'>pending</span>::<span class='ident'>Pending</span>; +<span class='kw'>use</span> <span class='ident'>readonly</span>::{ <span class='self'>self</span>, <span class='ident'>ReadOnly</span> }; +<span class='kw'>use</span> <span class='ident'>lift</span>; +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>use</span> <span class='ident'>testing</span>::<span class='ident'>ArcFn</span>; + + +<span class='doccomment'>/// A functional signal. Caches its return value during a transaction.</span> +<span class='kw'>struct</span> <span class='ident'>FuncSignal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>func</span>: <span class='ident'>Box</span><span class='op'><</span><span class='ident'>Fn</span>() <span class='op'>-></span> <span class='ident'>A</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='ident'>cache</span>: <span class='ident'>Arc</span><span class='op'><</span><span class='ident'>Mutex</span><span class='op'><</span><span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></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'>FuncSignal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>Fn</span>() <span class='op'>-></span> <span class='ident'>A</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='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>FuncSignal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>FuncSignal</span> { + <span class='ident'>func</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>f</span>), + <span class='ident'>cache</span>: <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='prelude-val'>None</span>)), + } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span> <span class='ident'>FuncSignal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Call the function or fetch the cached value if present.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>call</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>A</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>cached</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>cache</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(); + <span class='kw'>match</span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='op'>*</span><span class='ident'>cached</span> { + <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='prelude-val'>Some</span>(<span class='kw-2'>ref</span> <span class='ident'>value</span>) <span class='op'>=></span> <span class='ident'>value</span>.<span class='ident'>clone</span>(), + <span class='ident'>cached</span> <span class='op'>=></span> { + <span class='comment'>// Register callback to reset cache at the end of the transaction</span> + <span class='kw'>let</span> <span class='ident'>cache</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>cache</span>.<span class='ident'>clone</span>(); + <span class='ident'>end</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>live</span> <span class='op'>=</span> <span class='ident'>cache</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(); + <span class='op'>*</span><span class='ident'>live</span> <span class='op'>=</span> <span class='prelude-val'>None</span>; + }); + <span class='comment'>// Calculate & cache value</span> + <span class='kw'>let</span> <span class='ident'>value</span> <span class='op'>=</span> (<span class='self'>self</span>.<span class='ident'>func</span>)(); + <span class='op'>*</span><span class='ident'>cached</span> <span class='op'>=</span> <span class='prelude-val'>Some</span>(<span class='ident'>value</span>.<span class='ident'>clone</span>()); + <span class='ident'>value</span> + }, + } + } +} + + +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Const</span>(<span class='ident'>A</span>), + <span class='ident'>Func</span>(<span class='ident'>FuncSignal</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'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>from_fn</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>Fn</span>() <span class='op'>-></span> <span class='ident'>A</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='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>SignalFn</span>::<span class='ident'>Func</span>(<span class='ident'>FuncSignal</span>::<span class='ident'>new</span>(<span class='ident'>f</span>)) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>call</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>A</span> { + <span class='kw'>match</span> <span class='op'>*</span><span class='self'>self</span> { + <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>) <span class='op'>=></span> <span class='ident'>a</span>.<span class='ident'>clone</span>(), + <span class='ident'>SignalFn</span>::<span class='ident'>Func</span>(<span class='kw-2'>ref</span> <span class='ident'>f</span>) <span class='op'>=></span> <span class='ident'>f</span>.<span class='ident'>call</span>(), + } + } +} + + +<span class='doccomment'>/// Helper function to register callback handlers related to signal construction.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>reg_signal</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>parent_source</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>Source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>handler</span>: <span class='ident'>F</span>) + <span class='kw'>where</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='lifetime'>'static</span>, + <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></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='kw'>let</span> <span class='ident'>weak_source</span> <span class='op'>=</span> <span class='ident'>signal</span>.<span class='ident'>source</span>.<span class='ident'>downgrade</span>(); + <span class='kw'>let</span> <span class='ident'>weak_current</span> <span class='op'>=</span> <span class='ident'>signal</span>.<span class='ident'>current</span>.<span class='ident'>downgrade</span>(); + <span class='ident'>parent_source</span>.<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> + <span class='ident'>weak_current</span>.<span class='ident'>upgrade</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>cur</span><span class='op'>|</span> <span class='ident'>end</span>( + <span class='kw'>move</span> <span class='op'>||</span> { <span class='kw'>let</span> _ <span class='op'>=</span> <span class='ident'>cur</span>.<span class='ident'>write</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='kw-2'>mut</span> <span class='ident'>cur</span><span class='op'>|</span> <span class='ident'>cur</span>.<span class='ident'>update</span>()); })) + .<span class='ident'>ok_or</span>(<span class='ident'>CallbackError</span>::<span class='ident'>Disappeared</span>) + .<span class='ident'>and</span>(<span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak_current</span>, <span class='op'>|</span><span class='ident'>cur</span><span class='op'>|</span> <span class='ident'>cur</span>.<span class='ident'>queue</span>(<span class='ident'>handler</span>(<span class='ident'>a</span>)))) + .<span class='ident'>and</span>(<span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak_source</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(()))) + ); +} + + +<span class='doccomment'>/// External helper function to build a signal.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>signal_build</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>K</span><span class='op'>></span>(<span class='ident'>func</span>: <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>keep_alive</span>: <span class='ident'>K</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>K</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='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>func</span>, <span class='ident'>keep_alive</span>) +} + +<span class='doccomment'>/// External accessor to current state of a signal.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>signal_current</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>Pending</span><span class='op'><</span><span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span><span class='op'>>></span> { + <span class='kw-2'>&</span><span class='ident'>signal</span>.<span class='ident'>current</span> +} + +<span class='doccomment'>/// External accessor to signal source.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>signal_source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>Source</span><span class='op'><</span>()<span class='op'>>></span><span class='op'>></span> { + <span class='kw-2'>&</span><span class='ident'>signal</span>.<span class='ident'>source</span> +} + +<span class='doccomment'>/// Sample the value of the signal without committing it as a transaction.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>sample_raw</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span>(<span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</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='ident'>signal</span>.<span class='ident'>current</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>call</span>() +} + + +<span class='doccomment'>/// A continuous signal that changes over time.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Signals can be thought of as values that change over time. They have both a</span> +<span class='doccomment'>/// continuous and a discrete component. This means that their current value is</span> +<span class='doccomment'>/// defined by a function that can be called at any time. That function is only</span> +<span class='doccomment'>/// evaluated on-demand, when the signal's current value is sampled. (This is</span> +<span class='doccomment'>/// also called pull semantics in the literature on FRP.)</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// In addition, the current function used to sample a signal may change</span> +<span class='doccomment'>/// discretely in reaction to some event. For instance, it is possible to create</span> +<span class='doccomment'>/// a signal from an event stream, by holding the last event occurence as the</span> +<span class='doccomment'>/// current value of the stream.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Algebraic laws</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Signals come with some primitive methods to compose them with each other and</span> +<span class='doccomment'>/// with streams. Some of these primitives give the signals an algebraic</span> +<span class='doccomment'>/// structure.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ## Functor</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Signals form a functor under unary lifting. Thus, the following laws hold:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// - Preservation of identity: `lift!(|x| x, &a) == a`,</span> +<span class='doccomment'>/// - Function composition: `lift!(|x| g(f(x)), &a) == lift!(g, &lift!(f, &a))`.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ## Applicative functor</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// By extension, using the notion of a signal of a function, signals also</span> +<span class='doccomment'>/// become an [applicative][ghc-applicative] using `Signal::new` as `pure` and</span> +<span class='doccomment'>/// `|sf, sa| lift!(|f, a| f(a), &sf, &sa)` as `<*>`.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// *TODO: Expand on this and replace the Haskell reference.*</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// [ghc-applicative]: https://downloads.haskell.org/~ghc/latest/docs/html/libraries/base/Control-Applicative.html</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>current</span>: <span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>Pending</span><span class='op'><</span><span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span><span class='op'>>></span>, + <span class='ident'>source</span>: <span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>Source</span><span class='op'><</span>()<span class='op'>>></span><span class='op'>></span>, + <span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>dead_code</span>)]</span> + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span><span class='op'><</span><span class='ident'>BoxClone</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'>Clone</span> <span class='kw'>for</span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Signal</span> { + <span class='ident'>current</span>: <span class='self'>self</span>.<span class='ident'>current</span>.<span class='ident'>clone</span>(), + <span class='ident'>source</span>: <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>clone</span>(), + <span class='ident'>keep_alive</span>: <span class='self'>self</span>.<span class='ident'>keep_alive</span>.<span class='ident'>box_clone</span>(), + } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>build</span><span class='op'><</span><span class='ident'>K</span><span class='op'>></span>(<span class='ident'>func</span>: <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>keep_alive</span>: <span class='ident'>K</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>K</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='ident'>Signal</span> { + <span class='ident'>current</span>: <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='ident'>func</span>))), + <span class='ident'>source</span>: <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='ident'>Source</span>::<span class='ident'>new</span>())), + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>keep_alive</span>), + } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</span> <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a constant signal.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>a</span>: <span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>a</span>), ()) + } + + <span class='doccomment'>/// Sample the current value of the signal.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>sample</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>A</span> { + <span class='ident'>commit</span>(<span class='op'>||</span> <span class='ident'>sample_raw</span>(<span class='self'>self</span>)) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a signal with a cyclic definition.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The closure gets an undefined forward-declaration of a signal. It is</span> + <span class='doccomment'>/// supposed to return a self-referential definition of the same signal.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Sampling the forward-declared signal, before it is properly defined,</span> + <span class='doccomment'>/// will cause a run-time panic.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This pattern is useful to implement accumulators, counters and other</span> + <span class='doccomment'>/// loops that depend on the sampling behaviour of a signal before a</span> + <span class='doccomment'>/// transaction.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>cyclic</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>(<span class='ident'>def</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>FnOnce</span>(<span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + { + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>cycle</span> <span class='op'>=</span> <span class='ident'>SignalCycle</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>finished</span> <span class='op'>=</span> <span class='ident'>def</span>(<span class='kw-2'>&</span><span class='ident'>cycle</span>); + <span class='ident'>cycle</span>.<span class='ident'>define</span>(<span class='ident'>finished</span>) + }) + } + + <span class='doccomment'>/// Combine the signal with a stream in a snapshot.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// `snapshot` creates a new stream given a signal and a stream. Whenever</span> + <span class='doccomment'>/// the input stream fires an event, the output stream fires an event</span> + <span class='doccomment'>/// created from the signal's current value and that event using the</span> + <span class='doccomment'>/// supplied function.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink1: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let sink2: Sink<f64> = Sink::new();</span> + <span class='doccomment'>/// let mut events = sink1.stream().hold(1)</span> + <span class='doccomment'>/// .snapshot(&sink2.stream(), |a, b| (a, b))</span> + <span class='doccomment'>/// .events();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Updating its signal does not cause the snapshot to fire</span> + <span class='doccomment'>/// sink1.send(4);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // However sending an event down the stream does</span> + <span class='doccomment'>/// sink2.send(3.0);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some((4, 3.0)));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>snapshot</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</span>: <span class='ident'>Clone</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='ident'>C</span>: <span class='ident'>Clone</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='ident'>stream</span>::<span class='ident'>snapshot</span>(<span class='self'>self</span>, <span class='ident'>stream</span>, <span class='ident'>f</span>) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>Signal</span><span class='op'><</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span> { + <span class='doccomment'>/// Switch between signals.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This transforms a `Signal<Signal<A>>` into a `Signal<A>`. The nested</span> + <span class='doccomment'>/// signal can be thought of as a representation of a switch between different</span> + <span class='doccomment'>/// input signals, that allows one to change the structure of the dependency</span> + <span class='doccomment'>/// graph at run-time. `switch` provides a way to access the inner value of</span> + <span class='doccomment'>/// the currently active signal.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The following example demonstrates how to use this to switch between two</span> + <span class='doccomment'>/// input signals based on a `Button` event stream:</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// // Button type</span> + <span class='doccomment'>/// #[derive(Clone, Show)]</span> + <span class='doccomment'>/// enum Button { A, B };</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // The input sinks</span> + <span class='doccomment'>/// let sink_a = Sink::<i32>::new();</span> + <span class='doccomment'>/// let sink_b = Sink::<i32>::new();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // The button sink</span> + <span class='doccomment'>/// let sink_button = Sink::<Button>::new();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Create the output</span> + <span class='doccomment'>/// let output = {</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Hold input sinks in a signal with some initials</span> + <span class='doccomment'>/// let channel_a = sink_a.stream().hold(1);</span> + <span class='doccomment'>/// let channel_b = sink_b.stream().hold(2);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // A trivial default channel used before any button event</span> + <span class='doccomment'>/// let default_channel = Sink::new().stream().hold(0);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Map button to the channel signals, hold with the default channel as</span> + <span class='doccomment'>/// // initial value and switch between the signals</span> + <span class='doccomment'>/// sink_button</span> + <span class='doccomment'>/// .stream()</span> + <span class='doccomment'>/// .map(move |b| match b {</span> + <span class='doccomment'>/// Button::A => channel_a.clone(),</span> + <span class='doccomment'>/// Button::B => channel_b.clone(),</span> + <span class='doccomment'>/// })</span> + <span class='doccomment'>/// .hold(default_channel)</span> + <span class='doccomment'>/// .switch()</span> + <span class='doccomment'>/// };</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // In the beginning, output will come from the default channel</span> + <span class='doccomment'>/// assert_eq!(output.sample(), 0);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Let's switch to channel A</span> + <span class='doccomment'>/// sink_button.send(Button::A);</span> + <span class='doccomment'>/// assert_eq!(output.sample(), 1);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // And to channel B</span> + <span class='doccomment'>/// sink_button.send(Button::B);</span> + <span class='doccomment'>/// assert_eq!(output.sample(), 2);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // The channels can change, too, of course</span> + <span class='doccomment'>/// for k in 4..13 {</span> + <span class='doccomment'>/// sink_b.send(k);</span> + <span class='doccomment'>/// assert_eq!(output.sample(), k);</span> + <span class='doccomment'>/// }</span> + <span class='doccomment'>/// sink_button.send(Button::A);</span> + <span class='doccomment'>/// for k in 21..77 {</span> + <span class='doccomment'>/// sink_a.send(k);</span> + <span class='doccomment'>/// assert_eq!(output.sample(), k);</span> + <span class='doccomment'>/// }</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>switch</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>make_callback</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>parent</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>A</span>: <span class='ident'>Send</span> <span class='op'>+</span> <span class='ident'>Clone</span> <span class='op'>+</span> <span class='ident'>Sync</span> <span class='op'>+</span> <span class='lifetime'>'static</span>, + { + <span class='comment'>// TODO: use information on inner value</span> + <span class='kw'>let</span> <span class='ident'>current_signal</span> <span class='op'>=</span> <span class='ident'>parent</span>.<span class='ident'>current</span>.<span class='ident'>clone</span>(); + <span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='kw'>move</span> <span class='op'>||</span> + <span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>current_signal</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>call</span>()) + ) + } + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>make_callback</span>(<span class='self'>self</span>), ()); + <span class='kw'>let</span> <span class='ident'>parent</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>clone</span>(); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, + <span class='kw'>move</span> <span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>parent</span>)); + <span class='ident'>signal</span> + }) + } +} + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span><span class='op'>></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>ArcFn</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span><span class='op'>>></span> + <span class='kw'>where</span> <span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>B</span>: <span class='ident'>Clone</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='doccomment'>/// Applicative functionality. Applies a signal of function to a signal of</span> + <span class='doccomment'>/// its argument.</span> + <span class='kw'>fn</span> <span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> { + <span class='ident'>lift</span>::<span class='ident'>lift2</span>(<span class='op'>|</span><span class='ident'>f</span>, <span class='ident'>a</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='ident'>a</span>), <span class='self'>self</span>, <span class='ident'>signal</span>) + } +} + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Arbitrary</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'>Arbitrary</span> <span class='kw'>for</span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>arbitrary</span><span class='op'><</span><span class='ident'>G</span>: <span class='ident'>Gen</span><span class='op'>></span>(<span class='ident'>g</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>G</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>values</span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='op'><</span><span class='ident'>A</span><span class='op'>></span>::<span class='ident'>arbitrary</span>(<span class='ident'>g</span>); + <span class='kw'>if</span> <span class='ident'>values</span>.<span class='ident'>is_empty</span>() { + <span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='ident'>Arbitrary</span>::<span class='ident'>arbitrary</span>(<span class='ident'>g</span>)) + } <span class='kw'>else</span> { + <span class='kw'>let</span> <span class='ident'>n</span> <span class='op'>=</span> <span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='number'>0</span>); + <span class='ident'>lift</span>::<span class='ident'>lift0</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>n</span> <span class='op'>=</span> <span class='ident'>n</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(); + <span class='op'>*</span><span class='ident'>n</span> <span class='op'>+=</span> <span class='number'>1</span>; + <span class='kw'>if</span> <span class='op'>*</span><span class='ident'>n</span> <span class='op'>>=</span> <span class='ident'>values</span>.<span class='ident'>len</span>() { <span class='op'>*</span><span class='ident'>n</span> <span class='op'>=</span> <span class='number'>0</span> } + <span class='ident'>values</span>[<span class='op'>*</span><span class='ident'>n</span>].<span class='ident'>clone</span>() + }) + } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>fmt</span>::<span class='ident'>Debug</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'>fmt</span>::<span class='ident'>Debug</span> <span class='kw'>for</span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>fmt</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='prelude-ty'>Result</span><span class='op'><</span>(), <span class='ident'>fmt</span>::<span class='ident'>Error</span><span class='op'>></span> { + <span class='ident'>commit</span>(<span class='op'>||</span> <span class='kw'>match</span> <span class='op'>*</span><span class='op'>*</span><span class='self'>self</span>.<span class='ident'>current</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>() { + <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>) <span class='op'>=></span> + <span class='ident'>fmt</span>.<span class='ident'>debug_struct</span>(<span class='string'>"Signal::const"</span>).<span class='ident'>field</span>(<span class='string'>"value"</span>, <span class='kw-2'>&</span><span class='ident'>a</span>).<span class='ident'>finish</span>(), + <span class='ident'>SignalFn</span>::<span class='ident'>Func</span>(<span class='kw-2'>ref</span> <span class='ident'>f</span>) <span class='op'>=></span> + <span class='ident'>fmt</span>.<span class='ident'>debug_struct</span>(<span class='string'>"Signal::fn"</span>).<span class='ident'>field</span>(<span class='string'>"current"</span>, <span class='kw-2'>&</span><span class='ident'>f</span>.<span class='ident'>call</span>()).<span class='ident'>finish</span>(), + }) + } +} + + +<span class='doccomment'>/// Forward declaration of a signal to create value loops.</span> +<span class='kw'>struct</span> <span class='ident'>SignalCycle</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>signal</span>: <span class='ident'>Signal</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='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'>SignalCycle</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Forward-declare a new signal.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>SignalCycle</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>const</span> <span class='ident'>ERR</span>: <span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>str</span> <span class='op'>=</span> <span class='string'>"sampled on forward-declaration of signal"</span>; + <span class='ident'>SignalCycle</span> { <span class='ident'>signal</span>: <span class='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>(<span class='op'>||</span> <span class='macro'>panic</span><span class='macro'>!</span>(<span class='ident'>ERR</span>)), ()) } + } + + <span class='doccomment'>/// Provide the signal with a definition.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>define</span>(<span class='self'>self</span>, <span class='ident'>definition</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Generate a callback from the signal definition's current value.</span> + <span class='kw'>fn</span> <span class='ident'>make_callback</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>current_def</span>: <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</span><span class='op'><</span><span class='ident'>Pending</span><span class='op'><</span><span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span><span class='op'>>></span>) <span class='op'>-></span> <span class='ident'>SignalFn</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</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='kw'>match</span> <span class='op'>*</span><span class='ident'>current_def</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>future</span>() { + <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='kw-2'>ref</span> <span class='ident'>a</span>) <span class='op'>=></span> <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>a</span>.<span class='ident'>clone</span>()), + <span class='ident'>SignalFn</span>::<span class='ident'>Func</span>(_) <span class='op'>=></span> <span class='ident'>SignalFn</span>::<span class='ident'>from_fn</span>({ + <span class='kw'>let</span> <span class='ident'>sig</span> <span class='op'>=</span> <span class='ident'>current_def</span>.<span class='ident'>downgrade</span>(); + <span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>strong</span> <span class='op'>=</span> <span class='ident'>sig</span>.<span class='ident'>upgrade</span>().<span class='ident'>unwrap</span>(); + <span class='kw'>let</span> <span class='ident'>ret</span> <span class='op'>=</span> <span class='ident'>strong</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>().<span class='ident'>call</span>(); + <span class='ident'>ret</span> + } + }), + } + } + <span class='ident'>commit</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='op'>*</span><span class='self'>self</span>.<span class='ident'>signal</span>.<span class='ident'>current</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>() <span class='op'>=</span> <span class='ident'>Pending</span>::<span class='ident'>new</span>(<span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>definition</span>.<span class='ident'>current</span>)); + <span class='kw'>let</span> <span class='ident'>weak_parent</span> <span class='op'>=</span> <span class='ident'>definition</span>.<span class='ident'>current</span>.<span class='ident'>downgrade</span>(); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>definition</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>signal</span>, + <span class='kw'>move</span> <span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>make_callback</span>(<span class='kw-2'>&</span><span class='ident'>weak_parent</span>.<span class='ident'>upgrade</span>().<span class='ident'>unwrap</span>())); + <span class='ident'>Signal</span> { <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>definition</span>), ..<span class='self'>self</span>.<span class='ident'>signal</span> } + }) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>SignalCycle</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>; + <span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>signal</span> } +} + + +<span class='doccomment'>/// Signal variant using inner mutability for efficient in-place updates.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This is the only kind of primitive that allows non-`Clone` types to be</span> +<span class='doccomment'>/// wrapped into functional reactive abstractions. The API is somewhat different</span> +<span class='doccomment'>/// from that of a regular signal to accommodate this.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// One cannot directly sample a `SignalMut` as this would require a clone.</span> +<span class='doccomment'>/// Instead it comes with a couple of adaptor methods that mimick a subset of</span> +<span class='doccomment'>/// the `Signal` API. However, all functions passed to these methods take the</span> +<span class='doccomment'>/// argument coming from the `SignalMut` by reference.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>SignalMut</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>inner</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>ReadOnly</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='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='ident'>SignalMut</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Semantically the same as `Signal::snapshot`</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The key difference here is, that the combining function takes its first</span> + <span class='doccomment'>/// argument by reference, as it can't be moved out of the `SignalMut`.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// # Example</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink1 = Sink::new();</span> + <span class='doccomment'>/// let sink2 = Sink::new();</span> + <span class='doccomment'>/// // Collect values in a mutable `Vec`</span> + <span class='doccomment'>/// let values = sink1.stream().scan_mut(vec![], |v, a| v.push(a));</span> + <span class='doccomment'>/// // Snapshot some value from it</span> + <span class='doccomment'>/// let mut index = values.snapshot(&sink2.stream(),</span> + <span class='doccomment'>/// |v, k| v.get(k).map(|x| *x)</span> + <span class='doccomment'>/// ).events();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink1.send(4);</span> + <span class='doccomment'>/// sink1.send(5);</span> + <span class='doccomment'>/// sink2.send(0);</span> + <span class='doccomment'>/// assert_eq!(index.next(), Some(Some(4)));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink2.send(1);</span> + <span class='doccomment'>/// assert_eq!(index.next(), Some(Some(5)));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink2.send(2);</span> + <span class='doccomment'>/// assert_eq!(index.next(), Some(None));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>snapshot</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</span>: <span class='ident'>Clone</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='ident'>C</span>: <span class='ident'>Clone</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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'>inner</span>.<span class='ident'>snapshot</span>(<span class='ident'>stream</span>, <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>(), <span class='ident'>b</span>)) + } + + <span class='doccomment'>/// Similar to `lift2`. Combines a `SignalMut` with a `Signal` using a</span> + <span class='doccomment'>/// function. The function takes its first argument by reference.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>combine</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</span>: <span class='ident'>Clone</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='ident'>C</span>: <span class='ident'>Clone</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='ident'>lift</span>::<span class='ident'>lift2</span>( + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>(), <span class='ident'>b</span>), + <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>inner</span>, <span class='kw-2'>&</span><span class='ident'>signal</span> + ) + } + + <span class='doccomment'>/// Similar to `lift2`, but combines two `SignalMut` using a function. The</span> + <span class='doccomment'>/// supplied function takes both arguments by reference.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// # Example</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let sum = sink.stream().scan_mut(0, |sum, a| *sum += a);</span> + <span class='doccomment'>/// let product = sink.stream().scan_mut(1, |prod, a| *prod *= a);</span> + <span class='doccomment'>/// let combo = sum.combine_mut(&product, |s, p| (*s, *p));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink.send(1);</span> + <span class='doccomment'>/// assert_eq!(combo.sample(), (1, 1));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink.send(3);</span> + <span class='doccomment'>/// assert_eq!(combo.sample(), (4, 3));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// sink.send(5);</span> + <span class='doccomment'>/// assert_eq!(combo.sample(), (9, 15));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>combine_mut</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>SignalMut</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</span>: <span class='ident'>Clone</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='ident'>C</span>: <span class='ident'>Clone</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='ident'>A</span>, <span class='kw-2'>&</span><span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='ident'>lift</span>::<span class='ident'>lift2</span>( + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>b</span>.<span class='ident'>read</span>().<span class='ident'>unwrap</span>()), + <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>inner</span>, <span class='kw-2'>&</span><span class='ident'>other</span>.<span class='ident'>inner</span> + ) + } +} + + +<span class='doccomment'>/// Same as Stream::hold.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>hold</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>initial</span>: <span class='ident'>A</span>, <span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</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='lifetime'>'static</span>, +{ + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>initial</span>), <span class='ident'>stream</span>.<span class='ident'>clone</span>()); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>stream</span>::<span class='ident'>source</span>(<span class='kw-2'>&</span><span class='ident'>stream</span>).<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>); + <span class='ident'>signal</span> + }) +} + + +<span class='doccomment'>/// Same as Stream::scan_mut.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>scan_mut</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>initial</span>: <span class='ident'>B</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>SignalMut</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</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='lifetime'>'static</span>, + <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>B</span>, <span class='ident'>A</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='ident'>commit</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>state</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='ident'>initial</span>)); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>build</span>(<span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>readonly</span>::<span class='ident'>create</span>(<span class='ident'>state</span>.<span class='ident'>clone</span>())), <span class='ident'>stream</span>.<span class='ident'>clone</span>()); + <span class='ident'>reg_signal</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>stream</span>::<span class='ident'>source</span>(<span class='kw-2'>&</span><span class='ident'>stream</span>).<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='ident'>signal</span>, + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> { <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>state</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>(), <span class='ident'>a</span>); <span class='ident'>SignalFn</span>::<span class='ident'>Const</span>(<span class='ident'>readonly</span>::<span class='ident'>create</span>(<span class='ident'>state</span>.<span class='ident'>clone</span>())) }); + <span class='ident'>SignalMut</span> { <span class='ident'>inner</span>: <span class='ident'>signal</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'>quickcheck</span>::<span class='ident'>quickcheck</span>; + + <span class='kw'>use</span> ::<span class='ident'>stream</span>::<span class='ident'>Sink</span>; + <span class='kw'>use</span> ::<span class='ident'>signal</span>::{ <span class='self'>self</span>, <span class='ident'>Signal</span>, <span class='ident'>SignalCycle</span> }; + <span class='kw'>use</span> ::<span class='ident'>lift</span>::<span class='ident'>lift1</span>; + <span class='kw'>use</span> ::<span class='ident'>testing</span>::{ <span class='ident'>ArcFn</span>, <span class='ident'>signal_eq</span>, <span class='ident'>id</span>, <span class='ident'>pure_fn</span>, <span class='ident'>partial_comp</span> }; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>functor_identity</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>signal</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>(<span class='kw-2'>&</span><span class='ident'>signal</span>, <span class='kw-2'>&</span><span class='ident'>lift1</span>(<span class='ident'>id</span>, <span class='kw-2'>&</span><span class='ident'>signal</span>)); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>functor_composition</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>signal</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>fn</span> <span class='ident'>f</span>(<span class='ident'>n</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='number'>3</span> <span class='op'>*</span> <span class='ident'>n</span> } + <span class='kw'>fn</span> <span class='ident'>g</span>(<span class='ident'>n</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='ident'>n</span> <span class='op'>+</span> <span class='number'>2</span> } + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>( + <span class='kw-2'>&</span><span class='ident'>lift1</span>(<span class='op'>|</span><span class='ident'>n</span><span class='op'>|</span> <span class='ident'>f</span>(<span class='ident'>g</span>(<span class='ident'>n</span>)), <span class='kw-2'>&</span><span class='ident'>signal</span>), + <span class='kw-2'>&</span><span class='ident'>lift1</span>(<span class='ident'>f</span>, <span class='kw-2'>&</span><span class='ident'>lift1</span>(<span class='ident'>g</span>, <span class='kw-2'>&</span><span class='ident'>signal</span>)) + ); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>applicative_identity</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>signal</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>(<span class='kw-2'>&</span><span class='ident'>pure_fn</span>(<span class='ident'>id</span>).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>signal</span>), <span class='kw-2'>&</span><span class='ident'>signal</span>); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>applicative_composition</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>signal</span>: <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>fn</span> <span class='ident'>f</span>(<span class='ident'>n</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='ident'>n</span> <span class='op'>*</span> <span class='number'>4</span> } + <span class='kw'>fn</span> <span class='ident'>g</span>(<span class='ident'>n</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='ident'>n</span> <span class='op'>-</span> <span class='number'>3</span> } + <span class='kw'>let</span> <span class='ident'>u</span> <span class='op'>=</span> <span class='ident'>pure_fn</span>(<span class='ident'>f</span>); + <span class='kw'>let</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>pure_fn</span>(<span class='ident'>g</span>); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>( + <span class='kw-2'>&</span><span class='ident'>pure_fn</span>(<span class='ident'>partial_comp</span>).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>u</span>).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>v</span>).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>signal</span>), + <span class='kw-2'>&</span><span class='ident'>u</span>.<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>v</span>.<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>signal</span>)) + ); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Signal</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>applicative_homomorphism</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>x</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>fn</span> <span class='ident'>f</span>(<span class='ident'>x</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='ident'>x</span> <span class='op'>*</span> (<span class='op'>-</span><span class='number'>5</span>) } + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>( + <span class='kw-2'>&</span><span class='ident'>pure_fn</span>(<span class='ident'>f</span>).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='ident'>x</span>)), + <span class='kw-2'>&</span><span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='ident'>f</span>(<span class='ident'>x</span>)) + ); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>applicative_interchange</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>x</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>fn</span> <span class='ident'>f</span>(<span class='ident'>x</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i32</span> { <span class='ident'>x</span> <span class='op'>*</span> <span class='number'>2</span> <span class='op'>-</span> <span class='number'>7</span> } + <span class='kw'>let</span> <span class='ident'>u</span> <span class='op'>=</span> <span class='ident'>pure_fn</span>(<span class='ident'>f</span>); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>signal_eq</span>( + <span class='kw-2'>&</span><span class='ident'>u</span>.<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='ident'>x</span>)), + <span class='kw-2'>&</span><span class='ident'>pure_fn</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>f</span>: <span class='ident'>ArcFn</span><span class='op'><</span><span class='ident'>i32</span>, <span class='ident'>i32</span><span class='op'>></span><span class='op'>|</span> <span class='ident'>f</span>(<span class='ident'>x</span>)).<span class='ident'>apply</span>(<span class='kw-2'>&</span><span class='ident'>u</span>) + ); + (<span class='number'>0</span>..<span class='number'>10</span>).<span class='ident'>all</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>eq</span>.<span class='ident'>sample</span>()) + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>bool</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>clone</span>() { + <span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>new</span>(<span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>b</span>.<span class='ident'>clone</span>().<span class='ident'>sample</span>(), <span class='number'>3</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>hold</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>signal</span>.<span class='ident'>sample</span>(), <span class='number'>3</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>signal</span>.<span class='ident'>sample</span>(), <span class='number'>4</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>hold_implicit_stream</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>signal</span>::<span class='ident'>hold</span>(<span class='number'>0</span>, <span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>n</span><span class='op'>|</span> <span class='number'>2</span> <span class='op'>*</span> <span class='ident'>n</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>signal</span>.<span class='ident'>sample</span>(), <span class='number'>0</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>signal</span>.<span class='ident'>sample</span>(), <span class='number'>8</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>snapshot</span>() { + <span class='kw'>let</span> <span class='ident'>sink1</span>: <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink2</span>: <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>f64</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>snap_events</span> <span class='op'>=</span> <span class='ident'>sink1</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>1</span>) + .<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>sink2</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'>+</span> <span class='number'>3.0</span>), <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>)) + .<span class='ident'>events</span>(); + <span class='ident'>sink2</span>.<span class='ident'>send</span>(<span class='number'>4.0</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>snap_events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='number'>1</span>, <span class='number'>7.0</span>))); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>snapshot_2</span>() { + <span class='kw'>let</span> <span class='ident'>ev1</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>beh1</span> <span class='op'>=</span> <span class='ident'>ev1</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>5</span>); + <span class='kw'>let</span> <span class='ident'>ev2</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>snap</span> <span class='op'>=</span> <span class='ident'>beh1</span>.<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>ev2</span>.<span class='ident'>stream</span>(), <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>)); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>snap</span>.<span class='ident'>events</span>(); + <span class='ident'>ev2</span>.<span class='ident'>send</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='number'>5</span>, <span class='number'>4</span>))); + <span class='ident'>ev1</span>.<span class='ident'>send</span>(<span class='op'>-</span><span class='number'>2</span>); + <span class='ident'>ev2</span>.<span class='ident'>send</span>(<span class='number'>6</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='op'>-</span><span class='number'>2</span>, <span class='number'>6</span>))); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>cyclic_snapshot_accum</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>accum</span> <span class='op'>=</span> <span class='ident'>SignalCycle</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>def</span> <span class='op'>=</span> <span class='ident'>accum</span>.<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>stream</span>, <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>s</span><span class='op'>|</span> <span class='ident'>a</span> <span class='op'>+</span> <span class='ident'>s</span>).<span class='ident'>hold</span>(<span class='number'>0</span>); + <span class='kw'>let</span> <span class='ident'>accum</span> <span class='op'>=</span> <span class='ident'>accum</span>.<span class='ident'>define</span>(<span class='ident'>def</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>accum</span>.<span class='ident'>sample</span>(), <span class='number'>0</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>accum</span>.<span class='ident'>sample</span>(), <span class='number'>3</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>7</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>accum</span>.<span class='ident'>sample</span>(), <span class='number'>10</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='op'>-</span><span class='number'>21</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>accum</span>.<span class='ident'>sample</span>(), <span class='op'>-</span><span class='number'>11</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>snapshot_order_standard</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>0</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>signal</span> + .<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>(), <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>)) + .<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='number'>0</span>, <span class='number'>1</span>))); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>snapshot_lift_order_standard</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>0</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>lift1</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span>, <span class='kw-2'>&</span><span class='ident'>signal</span>) + .<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>(), <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>)) + .<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='number'>0</span>, <span class='number'>1</span>))); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>snapshot_order_alternative</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='comment'>// Invert the "natural" order of the registry by declaring the stream before</span> + <span class='comment'>// the signal, which are both used by the snapshot.</span> + <span class='kw'>let</span> <span class='ident'>first</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span>); + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>hold</span>(<span class='number'>0</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>signal</span>.<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>first</span>, <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> (<span class='ident'>a</span>, <span class='ident'>b</span>)).<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>((<span class='number'>0</span>, <span class='number'>1</span>))); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>cyclic_signal_intermediate</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>snap</span> <span class='op'>=</span> <span class='prelude-val'>None</span>; + <span class='kw'>let</span> <span class='ident'>sum</span> <span class='op'>=</span> <span class='ident'>Signal</span>::<span class='ident'>cyclic</span>(<span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> { + <span class='kw'>let</span> <span class='ident'>my_snap</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>snapshot</span>(<span class='kw-2'>&</span><span class='ident'>stream</span>, <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>e</span><span class='op'>|</span> <span class='ident'>e</span> <span class='op'>+</span> <span class='ident'>a</span>); + <span class='ident'>snap</span> <span class='op'>=</span> <span class='prelude-val'>Some</span>(<span class='ident'>my_snap</span>.<span class='ident'>clone</span>()); + <span class='ident'>my_snap</span>.<span class='ident'>hold</span>(<span class='number'>0</span>) + }); + <span class='kw'>let</span> <span class='ident'>snap</span> <span class='op'>=</span> <span class='ident'>snap</span>.<span class='ident'>unwrap</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>snap</span>.<span class='ident'>events</span>(); + + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>sum</span>.<span class='ident'>sample</span>(), <span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>3</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 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 diff --git a/src/carboxyl/stream.rs.html b/src/carboxyl/stream.rs.html new file mode 100644 index 0000000..8290275 --- /dev/null +++ b/src/carboxyl/stream.rs.html @@ -0,0 +1,1645 @@ +<!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/stream.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>stream.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> +<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> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +<span id="192">192</span> +<span id="193">193</span> +<span id="194">194</span> +<span id="195">195</span> +<span id="196">196</span> +<span id="197">197</span> +<span id="198">198</span> +<span id="199">199</span> +<span id="200">200</span> +<span id="201">201</span> +<span id="202">202</span> +<span id="203">203</span> +<span id="204">204</span> +<span id="205">205</span> +<span id="206">206</span> +<span id="207">207</span> +<span id="208">208</span> +<span id="209">209</span> +<span id="210">210</span> +<span id="211">211</span> +<span id="212">212</span> +<span id="213">213</span> +<span id="214">214</span> +<span id="215">215</span> +<span id="216">216</span> +<span id="217">217</span> +<span id="218">218</span> +<span id="219">219</span> +<span id="220">220</span> +<span id="221">221</span> +<span id="222">222</span> +<span id="223">223</span> +<span id="224">224</span> +<span id="225">225</span> +<span id="226">226</span> +<span id="227">227</span> +<span id="228">228</span> +<span id="229">229</span> +<span id="230">230</span> +<span id="231">231</span> +<span id="232">232</span> +<span id="233">233</span> +<span id="234">234</span> +<span id="235">235</span> +<span id="236">236</span> +<span id="237">237</span> +<span id="238">238</span> +<span id="239">239</span> +<span id="240">240</span> +<span id="241">241</span> +<span id="242">242</span> +<span id="243">243</span> +<span id="244">244</span> +<span id="245">245</span> +<span id="246">246</span> +<span id="247">247</span> +<span id="248">248</span> +<span id="249">249</span> +<span id="250">250</span> +<span id="251">251</span> +<span id="252">252</span> +<span id="253">253</span> +<span id="254">254</span> +<span id="255">255</span> +<span id="256">256</span> +<span id="257">257</span> +<span id="258">258</span> +<span id="259">259</span> +<span id="260">260</span> +<span id="261">261</span> +<span id="262">262</span> +<span id="263">263</span> +<span id="264">264</span> +<span id="265">265</span> +<span id="266">266</span> +<span id="267">267</span> +<span id="268">268</span> +<span id="269">269</span> +<span id="270">270</span> +<span id="271">271</span> +<span id="272">272</span> +<span id="273">273</span> +<span id="274">274</span> +<span id="275">275</span> +<span id="276">276</span> +<span id="277">277</span> +<span id="278">278</span> +<span id="279">279</span> +<span id="280">280</span> +<span id="281">281</span> +<span id="282">282</span> +<span id="283">283</span> +<span id="284">284</span> +<span id="285">285</span> +<span id="286">286</span> +<span id="287">287</span> +<span id="288">288</span> +<span id="289">289</span> +<span id="290">290</span> +<span id="291">291</span> +<span id="292">292</span> +<span id="293">293</span> +<span id="294">294</span> +<span id="295">295</span> +<span id="296">296</span> +<span id="297">297</span> +<span id="298">298</span> +<span id="299">299</span> +<span id="300">300</span> +<span id="301">301</span> +<span id="302">302</span> +<span id="303">303</span> +<span id="304">304</span> +<span id="305">305</span> +<span id="306">306</span> +<span id="307">307</span> +<span id="308">308</span> +<span id="309">309</span> +<span id="310">310</span> +<span id="311">311</span> +<span id="312">312</span> +<span id="313">313</span> +<span id="314">314</span> +<span id="315">315</span> +<span id="316">316</span> +<span id="317">317</span> +<span id="318">318</span> +<span id="319">319</span> +<span id="320">320</span> +<span id="321">321</span> +<span id="322">322</span> +<span id="323">323</span> +<span id="324">324</span> +<span id="325">325</span> +<span id="326">326</span> +<span id="327">327</span> +<span id="328">328</span> +<span id="329">329</span> +<span id="330">330</span> +<span id="331">331</span> +<span id="332">332</span> +<span id="333">333</span> +<span id="334">334</span> +<span id="335">335</span> +<span id="336">336</span> +<span id="337">337</span> +<span id="338">338</span> +<span id="339">339</span> +<span id="340">340</span> +<span id="341">341</span> +<span id="342">342</span> +<span id="343">343</span> +<span id="344">344</span> +<span id="345">345</span> +<span id="346">346</span> +<span id="347">347</span> +<span id="348">348</span> +<span id="349">349</span> +<span id="350">350</span> +<span id="351">351</span> +<span id="352">352</span> +<span id="353">353</span> +<span id="354">354</span> +<span id="355">355</span> +<span id="356">356</span> +<span id="357">357</span> +<span id="358">358</span> +<span id="359">359</span> +<span id="360">360</span> +<span id="361">361</span> +<span id="362">362</span> +<span id="363">363</span> +<span id="364">364</span> +<span id="365">365</span> +<span id="366">366</span> +<span id="367">367</span> +<span id="368">368</span> +<span id="369">369</span> +<span id="370">370</span> +<span id="371">371</span> +<span id="372">372</span> +<span id="373">373</span> +<span id="374">374</span> +<span id="375">375</span> +<span id="376">376</span> +<span id="377">377</span> +<span id="378">378</span> +<span id="379">379</span> +<span id="380">380</span> +<span id="381">381</span> +<span id="382">382</span> +<span id="383">383</span> +<span id="384">384</span> +<span id="385">385</span> +<span id="386">386</span> +<span id="387">387</span> +<span id="388">388</span> +<span id="389">389</span> +<span id="390">390</span> +<span id="391">391</span> +<span id="392">392</span> +<span id="393">393</span> +<span id="394">394</span> +<span id="395">395</span> +<span id="396">396</span> +<span id="397">397</span> +<span id="398">398</span> +<span id="399">399</span> +<span id="400">400</span> +<span id="401">401</span> +<span id="402">402</span> +<span id="403">403</span> +<span id="404">404</span> +<span id="405">405</span> +<span id="406">406</span> +<span id="407">407</span> +<span id="408">408</span> +<span id="409">409</span> +<span id="410">410</span> +<span id="411">411</span> +<span id="412">412</span> +<span id="413">413</span> +<span id="414">414</span> +<span id="415">415</span> +<span id="416">416</span> +<span id="417">417</span> +<span id="418">418</span> +<span id="419">419</span> +<span id="420">420</span> +<span id="421">421</span> +<span id="422">422</span> +<span id="423">423</span> +<span id="424">424</span> +<span id="425">425</span> +<span id="426">426</span> +<span id="427">427</span> +<span id="428">428</span> +<span id="429">429</span> +<span id="430">430</span> +<span id="431">431</span> +<span id="432">432</span> +<span id="433">433</span> +<span id="434">434</span> +<span id="435">435</span> +<span id="436">436</span> +<span id="437">437</span> +<span id="438">438</span> +<span id="439">439</span> +<span id="440">440</span> +<span id="441">441</span> +<span id="442">442</span> +<span id="443">443</span> +<span id="444">444</span> +<span id="445">445</span> +<span id="446">446</span> +<span id="447">447</span> +<span id="448">448</span> +<span id="449">449</span> +<span id="450">450</span> +<span id="451">451</span> +<span id="452">452</span> +<span id="453">453</span> +<span id="454">454</span> +<span id="455">455</span> +<span id="456">456</span> +<span id="457">457</span> +<span id="458">458</span> +<span id="459">459</span> +<span id="460">460</span> +<span id="461">461</span> +<span id="462">462</span> +<span id="463">463</span> +<span id="464">464</span> +<span id="465">465</span> +<span id="466">466</span> +<span id="467">467</span> +<span id="468">468</span> +<span id="469">469</span> +<span id="470">470</span> +<span id="471">471</span> +<span id="472">472</span> +<span id="473">473</span> +<span id="474">474</span> +<span id="475">475</span> +<span id="476">476</span> +<span id="477">477</span> +<span id="478">478</span> +<span id="479">479</span> +<span id="480">480</span> +<span id="481">481</span> +<span id="482">482</span> +<span id="483">483</span> +<span id="484">484</span> +<span id="485">485</span> +<span id="486">486</span> +<span id="487">487</span> +<span id="488">488</span> +<span id="489">489</span> +<span id="490">490</span> +<span id="491">491</span> +<span id="492">492</span> +<span id="493">493</span> +<span id="494">494</span> +<span id="495">495</span> +<span id="496">496</span> +<span id="497">497</span> +<span id="498">498</span> +<span id="499">499</span> +<span id="500">500</span> +<span id="501">501</span> +<span id="502">502</span> +<span id="503">503</span> +<span id="504">504</span> +<span id="505">505</span> +<span id="506">506</span> +<span id="507">507</span> +<span id="508">508</span> +<span id="509">509</span> +<span id="510">510</span> +<span id="511">511</span> +<span id="512">512</span> +<span id="513">513</span> +<span id="514">514</span> +<span id="515">515</span> +<span id="516">516</span> +<span id="517">517</span> +<span id="518">518</span> +<span id="519">519</span> +<span id="520">520</span> +<span id="521">521</span> +<span id="522">522</span> +<span id="523">523</span> +<span id="524">524</span> +<span id="525">525</span> +<span id="526">526</span> +<span id="527">527</span> +<span id="528">528</span> +<span id="529">529</span> +<span id="530">530</span> +<span id="531">531</span> +<span id="532">532</span> +<span id="533">533</span> +<span id="534">534</span> +<span id="535">535</span> +<span id="536">536</span> +<span id="537">537</span> +<span id="538">538</span> +<span id="539">539</span> +<span id="540">540</span> +<span id="541">541</span> +<span id="542">542</span> +<span id="543">543</span> +<span id="544">544</span> +<span id="545">545</span> +<span id="546">546</span> +<span id="547">547</span> +<span id="548">548</span> +<span id="549">549</span> +<span id="550">550</span> +<span id="551">551</span> +<span id="552">552</span> +<span id="553">553</span> +<span id="554">554</span> +<span id="555">555</span> +<span id="556">556</span> +<span id="557">557</span> +<span id="558">558</span> +<span id="559">559</span> +<span id="560">560</span> +<span id="561">561</span> +<span id="562">562</span> +<span id="563">563</span> +<span id="564">564</span> +<span id="565">565</span> +<span id="566">566</span> +<span id="567">567</span> +<span id="568">568</span> +<span id="569">569</span> +<span id="570">570</span> +<span id="571">571</span> +<span id="572">572</span> +<span id="573">573</span> +<span id="574">574</span> +<span id="575">575</span> +<span id="576">576</span> +<span id="577">577</span> +<span id="578">578</span> +<span id="579">579</span> +<span id="580">580</span> +<span id="581">581</span> +<span id="582">582</span> +<span id="583">583</span> +<span id="584">584</span> +<span id="585">585</span> +<span id="586">586</span> +<span id="587">587</span> +<span id="588">588</span> +<span id="589">589</span> +<span id="590">590</span> +<span id="591">591</span> +<span id="592">592</span> +<span id="593">593</span> +<span id="594">594</span> +<span id="595">595</span> +<span id="596">596</span> +<span id="597">597</span> +<span id="598">598</span> +<span id="599">599</span> +<span id="600">600</span> +<span id="601">601</span> +<span id="602">602</span> +<span id="603">603</span> +<span id="604">604</span> +<span id="605">605</span> +<span id="606">606</span> +<span id="607">607</span> +<span id="608">608</span> +<span id="609">609</span> +<span id="610">610</span> +<span id="611">611</span> +<span id="612">612</span> +<span id="613">613</span> +<span id="614">614</span> +<span id="615">615</span> +<span id="616">616</span> +<span id="617">617</span> +<span id="618">618</span> +<span id="619">619</span> +<span id="620">620</span> +<span id="621">621</span> +<span id="622">622</span> +<span id="623">623</span> +<span id="624">624</span> +<span id="625">625</span> +<span id="626">626</span> +<span id="627">627</span> +<span id="628">628</span> +<span id="629">629</span> +<span id="630">630</span> +<span id="631">631</span> +<span id="632">632</span> +<span id="633">633</span> +<span id="634">634</span> +<span id="635">635</span> +<span id="636">636</span> +<span id="637">637</span> +<span id="638">638</span> +<span id="639">639</span> +<span id="640">640</span> +<span id="641">641</span> +<span id="642">642</span> +<span id="643">643</span> +<span id="644">644</span> +<span id="645">645</span> +<span id="646">646</span> +<span id="647">647</span> +<span id="648">648</span> +<span id="649">649</span> +<span id="650">650</span> +<span id="651">651</span> +<span id="652">652</span> +<span id="653">653</span> +<span id="654">654</span> +<span id="655">655</span> +<span id="656">656</span> +<span id="657">657</span> +<span id="658">658</span> +<span id="659">659</span> +<span id="660">660</span> +<span id="661">661</span> +<span id="662">662</span> +<span id="663">663</span> +<span id="664">664</span> +<span id="665">665</span> +<span id="666">666</span> +<span id="667">667</span> +<span id="668">668</span> +<span id="669">669</span> +<span id="670">670</span> +<span id="671">671</span> +<span id="672">672</span> +<span id="673">673</span> +<span id="674">674</span> +<span id="675">675</span> +<span id="676">676</span> +<span id="677">677</span> +<span id="678">678</span> +<span id="679">679</span> +<span id="680">680</span> +<span id="681">681</span> +<span id="682">682</span> +<span id="683">683</span> +<span id="684">684</span> +<span id="685">685</span> +<span id="686">686</span> +<span id="687">687</span> +<span id="688">688</span> +<span id="689">689</span> +<span id="690">690</span> +<span id="691">691</span> +<span id="692">692</span> +<span id="693">693</span> +<span id="694">694</span> +<span id="695">695</span> +<span id="696">696</span> +<span id="697">697</span> +<span id="698">698</span> +<span id="699">699</span> +<span id="700">700</span> +<span id="701">701</span> +<span id="702">702</span> +<span id="703">703</span> +<span id="704">704</span> +<span id="705">705</span> +<span id="706">706</span> +<span id="707">707</span> +<span id="708">708</span> +<span id="709">709</span> +<span id="710">710</span> +<span id="711">711</span> +<span id="712">712</span> +<span id="713">713</span> +<span id="714">714</span> +<span id="715">715</span> +<span id="716">716</span> +<span id="717">717</span> +<span id="718">718</span> +<span id="719">719</span> +<span id="720">720</span> +<span id="721">721</span> +<span id="722">722</span> +<span id="723">723</span> +<span id="724">724</span> +<span id="725">725</span> +<span id="726">726</span> +<span id="727">727</span> +<span id="728">728</span> +<span id="729">729</span> +<span id="730">730</span> +<span id="731">731</span> +<span id="732">732</span> +<span id="733">733</span> +<span id="734">734</span> +<span id="735">735</span> +<span id="736">736</span> +<span id="737">737</span> +<span id="738">738</span> +<span id="739">739</span> +<span id="740">740</span> +<span id="741">741</span> +<span id="742">742</span> +<span id="743">743</span> +<span id="744">744</span> +<span id="745">745</span> +<span id="746">746</span> +<span id="747">747</span> +<span id="748">748</span> +<span id="749">749</span> +<span id="750">750</span> +<span id="751">751</span> +<span id="752">752</span> +<span id="753">753</span> +<span id="754">754</span> +<span id="755">755</span> +<span id="756">756</span> +<span id="757">757</span> +<span id="758">758</span> +<span id="759">759</span> +<span id="760">760</span> +<span id="761">761</span> +<span id="762">762</span> +<span id="763">763</span> +<span id="764">764</span> +<span id="765">765</span> +<span id="766">766</span> +<span id="767">767</span> +<span id="768">768</span> +<span id="769">769</span> +<span id="770">770</span> +<span id="771">771</span> +<span id="772">772</span> +<span id="773">773</span> +<span id="774">774</span> +</pre><pre class='rust '> +<span class='doccomment'>//! Streams of discrete events</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='ident'>Mutex</span>, <span class='ident'>Weak</span> }; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>mpsc</span>::{ <span class='ident'>Receiver</span>, <span class='ident'>channel</span> }; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>; +<span class='kw'>use</span> <span class='ident'>source</span>::{ <span class='ident'>Source</span>, <span class='ident'>CallbackError</span>, <span class='ident'>CallbackResult</span>, <span class='ident'>with_weak</span> }; +<span class='kw'>use</span> <span class='ident'>signal</span>::{ <span class='self'>self</span>, <span class='ident'>Signal</span>, <span class='ident'>SignalMut</span>, <span class='ident'>sample_raw</span> }; +<span class='kw'>use</span> <span class='ident'>transaction</span>::{ <span class='ident'>commit</span>, <span class='ident'>later</span> }; + + +<span class='doccomment'>/// An event sink.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This primitive is a way of generating streams of events. One can send</span> +<span class='doccomment'>/// input values into a sink and generate a stream that fires all these inputs</span> +<span class='doccomment'>/// as events:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>/// # use carboxyl::Sink;</span> +<span class='doccomment'>/// // A new sink</span> +<span class='doccomment'>/// let sink = Sink::new();</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// // Make an iterator over a stream.</span> +<span class='doccomment'>/// let mut events = sink.stream().events();</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// // Send a value into the sink</span> +<span class='doccomment'>/// sink.send(5);</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// // The stream</span> +<span class='doccomment'>/// assert_eq!(events.next(), Some(5));</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// You can also feed a sink with an iterator:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>/// # use carboxyl::Sink;</span> +<span class='doccomment'>/// # let sink = Sink::new();</span> +<span class='doccomment'>/// # let mut events = sink.stream().events();</span> +<span class='doccomment'>/// sink.feed(20..40);</span> +<span class='doccomment'>/// assert_eq!(events.take(4).collect::<Vec<_>>(), vec![20, 21, 22, 23]);</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Asynchronous calls</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// It is possible to send events into the sink asynchronously using the methods</span> +<span class='doccomment'>/// `send_async` and `feed_async`. Note though, that this will void some</span> +<span class='doccomment'>/// guarantees on the order of events. In the following example, it is unclear,</span> +<span class='doccomment'>/// which event is the first in the stream:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>/// # use carboxyl::Sink;</span> +<span class='doccomment'>/// let sink = Sink::new();</span> +<span class='doccomment'>/// let mut events = sink.stream().events();</span> +<span class='doccomment'>/// sink.send_async(13);</span> +<span class='doccomment'>/// sink.send_async(22);</span> +<span class='doccomment'>/// let first = events.next().unwrap();</span> +<span class='doccomment'>/// assert!(first == 13 || first == 22);</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// `feed_async` provides a workaround, as it preserves the order of events from</span> +<span class='doccomment'>/// the iterator. However, any event sent into the sink after a call to it, may</span> +<span class='doccomment'>/// come at any point between the iterator events.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>source</span>: <span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</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='op'>></span>, +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> <span class='ident'>Clone</span> <span class='kw'>for</span> <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Sink</span> { <span class='ident'>source</span>: <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>clone</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'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a new sink.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Sink</span> { <span class='ident'>source</span>: <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='ident'>Source</span>::<span class='ident'>new</span>())) } + } + + <span class='doccomment'>/// Generate a stream that fires all events sent into the sink.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>stream</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Stream</span> { <span class='ident'>source</span>: <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>clone</span>(), <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</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'>Sink</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Asynchronous send.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Same as `send`, but it spawns a new thread to process the updates to</span> + <span class='doccomment'>/// dependent streams and signals.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>send_async</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>a</span>: <span class='ident'>A</span>) { + <span class='kw'>let</span> <span class='ident'>clone</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>clone</span>(); + <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>clone</span>.<span class='ident'>send</span>(<span class='ident'>a</span>)); + } + + <span class='doccomment'>/// Feed values from an iterator into the sink.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This method feeds events into the sink from an iterator.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>feed</span><span class='op'><</span><span class='ident'>I</span>: <span class='ident'>IntoIterator</span><span class='op'><</span><span class='ident'>Item</span><span class='op'>=</span><span class='ident'>A</span><span class='op'>>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>iterator</span>: <span class='ident'>I</span>) { + <span class='kw'>for</span> <span class='ident'>event</span> <span class='kw'>in</span> <span class='ident'>iterator</span> { + <span class='self'>self</span>.<span class='ident'>send</span>(<span class='ident'>event</span>); + } + } + + <span class='doccomment'>/// Asynchronous feed.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This is the same as `feed`, but it does not block, since it spawns the</span> + <span class='doccomment'>/// feeding as a new task. This is useful, if the provided iterator is large</span> + <span class='doccomment'>/// or even infinite (e.g. an I/O event loop).</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>feed_async</span><span class='op'><</span><span class='ident'>I</span>: <span class='ident'>IntoIterator</span><span class='op'><</span><span class='ident'>Item</span><span class='op'>=</span><span class='ident'>A</span><span class='op'>></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='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>iterator</span>: <span class='ident'>I</span>) { + <span class='kw'>let</span> <span class='ident'>clone</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>clone</span>(); + <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>clone</span>.<span class='ident'>feed</span>(<span class='ident'>iterator</span>)); + } + + <span class='doccomment'>/// Send a value into the sink.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// When a value is sent into the sink, an event is fired in all dependent</span> + <span class='doccomment'>/// streams.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>send</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>a</span>: <span class='ident'>A</span>) { + <span class='ident'>commit</span>(<span class='op'>||</span> <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>send</span>(<span class='ident'>a</span>)) + } +} + + +<span class='doccomment'>/// Trait to wrap cloning of boxed values in a object-safe manner</span> +<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>BoxClone</span>: <span class='ident'>Sync</span> <span class='op'>+</span> <span class='ident'>Send</span> { + <span class='doccomment'>/// Clone the object as a boxed trait object</span> + <span class='kw'>fn</span> <span class='ident'>box_clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>BoxClone</span><span class='op'>></span>; +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>Sync</span> <span class='op'>+</span> <span class='ident'>Send</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'>BoxClone</span> <span class='kw'>for</span> <span class='ident'>T</span> { + <span class='kw'>fn</span> <span class='ident'>box_clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>BoxClone</span><span class='op'>></span> { + <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>clone</span>()) + } +} + + +<span class='doccomment'>/// Access a stream's source.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// This is not defined as a method, so that it can be public to other modules</span> +<span class='doccomment'>/// in this crate while being private outside the crate.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>source</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</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='op'>></span> { + <span class='kw-2'>&</span><span class='ident'>stream</span>.<span class='ident'>source</span> +} + + +<span class='doccomment'>/// A stream of events.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Conceptually a stream can be thought of as a series of discrete events that</span> +<span class='doccomment'>/// occur at specific times. They are ordered by a transaction system. This</span> +<span class='doccomment'>/// means that firings of disjoint events can not interfere with each other. The</span> +<span class='doccomment'>/// consequences of one event are atomically reflected in dependent quantities.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Streams provide a number of primitive operations. These can be used to</span> +<span class='doccomment'>/// compose streams and combine them with signals. For instance, streams can be</span> +<span class='doccomment'>/// mapped over with a function, merged with another stream of the same type or</span> +<span class='doccomment'>/// filtered by some predicate.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Algebraic laws</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Furthermore, streams satisfy certain algebraic properties that are useful to</span> +<span class='doccomment'>/// reason about them.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ## Monoid</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// For once, streams of the same type form a **monoid** under merging. The</span> +<span class='doccomment'>/// neutral element in this context is `Stream::never()`. So the following laws</span> +<span class='doccomment'>/// always hold for streams `a`, `b` and `c` of the same type:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// - Left identity: `Stream::never().merge(&a) == a`,</span> +<span class='doccomment'>/// - Right identity: `a.merge(&Stream::never()) == a`,</span> +<span class='doccomment'>/// - Associativity: `a.merge(&b).merge(&c) == a.merge(&b.merge(&c))`.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// *Note that equality in this context is not actually implemented as such,</span> +<span class='doccomment'>/// since comparing two (potentially infinite) streams is a prohibitive</span> +<span class='doccomment'>/// operation. Instead, the expressions above can be used interchangably and</span> +<span class='doccomment'>/// behave identically.*</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ## Functor</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Under the mapping operation streams also become a functor. A functor is a</span> +<span class='doccomment'>/// generic type like `Stream` with some mapping operation that takes a function</span> +<span class='doccomment'>/// `Fn(A) -> B` to map a `Stream<A>` to a `Stream<B>`. Algebraically it</span> +<span class='doccomment'>/// satisfies the following laws:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// - The identity function is preserved: `a.map(|x| x) == a`,</span> +<span class='doccomment'>/// - Function composition is respected: `a.map(f).map(g) == a.map(|x| g(f(x)))`.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>source</span>: <span class='ident'>Arc</span><span class='op'><</span><span class='ident'>RwLock</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='op'>></span>, + <span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>dead_code</span>)]</span> + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span><span class='op'><</span><span class='ident'>BoxClone</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'>Clone</span> <span class='kw'>for</span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>clone</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>clone</span>(), + <span class='ident'>keep_alive</span>: <span class='self'>self</span>.<span class='ident'>keep_alive</span>.<span class='ident'>box_clone</span>(), + } + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a stream that never fires. This can be useful in certain</span> + <span class='doccomment'>/// situations, where a stream is logically required, but no events are</span> + <span class='doccomment'>/// expected.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>never</span>() <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>RwLock</span>::<span class='ident'>new</span>(<span class='ident'>Source</span>::<span class='ident'>new</span>())), + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(()) + } + } + + <span class='doccomment'>/// Map the stream to another stream using a function.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// `map` applies a function to every event fired in this stream to create a</span> + <span class='doccomment'>/// new stream of type `B`.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let mut events = sink.stream().map(|x| x + 4).events();</span> + <span class='doccomment'>/// sink.send(3);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(7));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>map</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>B</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='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>() + .<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>f</span>(<span class='ident'>a</span>)))); + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>src</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>clone</span>()), + } + }) + } + + <span class='doccomment'>/// Filter a stream according to a predicate.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// `filter` creates a new stream that only fires those events from the</span> + <span class='doccomment'>/// original stream that satisfy the predicate.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let mut events = sink.stream()</span> + <span class='doccomment'>/// .filter(|&x| (x >= 4) && (x <= 10))</span> + <span class='doccomment'>/// .events();</span> + <span class='doccomment'>/// sink.send(2); // won't arrive</span> + <span class='doccomment'>/// sink.send(5); // will arrive</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(5));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>filter</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>bool</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'>filter_map</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='kw'>if</span> <span class='ident'>f</span>(<span class='kw-2'>&</span><span class='ident'>a</span>) { <span class='prelude-val'>Some</span>(<span class='ident'>a</span>) } <span class='kw'>else</span> { <span class='prelude-val'>None</span> }) + } + + <span class='doccomment'>/// Both filter and map a stream.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This is equivalent to `.map(f).filter_some()`.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink = Sink::new();</span> + <span class='doccomment'>/// let mut events = sink.stream()</span> + <span class='doccomment'>/// .filter_map(|i| if i > 3 { Some(i + 2) } else { None })</span> + <span class='doccomment'>/// .events();</span> + <span class='doccomment'>/// sink.send(2);</span> + <span class='doccomment'>/// sink.send(4);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(6));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>filter_map</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></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'>map</span>(<span class='ident'>f</span>).<span class='ident'>filter_some</span>() + } + + <span class='doccomment'>/// Merge with another stream.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// `merge` takes two streams and creates a new stream that fires events</span> + <span class='doccomment'>/// from both input streams.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink_1 = Sink::<i32>::new();</span> + <span class='doccomment'>/// let sink_2 = Sink::<i32>::new();</span> + <span class='doccomment'>/// let mut events = sink_1.stream().merge(&sink_2.stream()).events();</span> + <span class='doccomment'>/// sink_1.send(2);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(2));</span> + <span class='doccomment'>/// sink_2.send(4);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(4));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>for</span> <span class='ident'>parent</span> <span class='kw'>in</span> [<span class='self'>self</span>, <span class='ident'>other</span>].<span class='ident'>iter</span>() { + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='ident'>parent</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>() + .<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>a</span>))); + } + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>src</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>((<span class='self'>self</span>.<span class='ident'>clone</span>(), <span class='ident'>other</span>.<span class='ident'>clone</span>())), + } + }) + } + + <span class='doccomment'>/// Coalesce multiple event firings within the same transaction into a</span> + <span class='doccomment'>/// single event.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The function should ideally commute, as the order of events within a</span> + <span class='doccomment'>/// transaction is not well-defined.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>coalesce</span><span class='op'><</span><span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>A</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='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>register</span>({ + <span class='kw'>let</span> <span class='ident'>mutex</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='prelude-val'>None</span>)); + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>inner</span> <span class='op'>=</span> <span class='ident'>mutex</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(); + <span class='op'>*</span><span class='ident'>inner</span> <span class='op'>=</span> <span class='prelude-val'>Some</span>(<span class='kw'>match</span> <span class='ident'>inner</span>.<span class='ident'>take</span>() { + <span class='prelude-val'>Some</span>(<span class='ident'>b</span>) <span class='op'>=></span> <span class='ident'>f</span>(<span class='ident'>a</span>, <span class='ident'>b</span>), + <span class='prelude-val'>None</span> <span class='op'>=></span> <span class='ident'>a</span>, + }); + <span class='comment'>// Send the updated value later</span> + <span class='ident'>later</span>({ + <span class='kw'>let</span> <span class='ident'>mutex</span> <span class='op'>=</span> <span class='ident'>mutex</span>.<span class='ident'>clone</span>(); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>weak</span>.<span class='ident'>clone</span>(); + <span class='kw'>move</span> <span class='op'>||</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>inner</span> <span class='op'>=</span> <span class='ident'>mutex</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(); + <span class='comment'>// Take it out and map, so that it does not happen twice</span> + <span class='ident'>inner</span>.<span class='ident'>take</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>value</span><span class='op'>|</span> + <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>value</span>)) + ); + } + }); + <span class='prelude-val'>Ok</span>(()) + } + }); + <span class='ident'>Stream</span> { <span class='ident'>source</span>: <span class='ident'>src</span>, <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>clone</span>()) } + }) + } + + <span class='doccomment'>/// Hold an event in a signal.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The resulting signal `hold`s the value of the last event fired by the</span> + <span class='doccomment'>/// stream.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink = Sink::new();</span> + <span class='doccomment'>/// let signal = sink.stream().hold(0);</span> + <span class='doccomment'>/// assert_eq!(signal.sample(), 0);</span> + <span class='doccomment'>/// sink.send(2);</span> + <span class='doccomment'>/// assert_eq!(signal.sample(), 2);</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>hold</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>initial</span>: <span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>signal</span>::<span class='ident'>hold</span>(<span class='ident'>initial</span>, <span class='self'>self</span>) + } + + <span class='doccomment'>/// A blocking iterator over the stream.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>events</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Events</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { <span class='ident'>Events</span>::<span class='ident'>new</span>(<span class='self'>self</span>) } + + <span class='doccomment'>/// Scan a stream and accumulate its event firings in a signal.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Starting at some initial value, each new event changes the value of the</span> + <span class='doccomment'>/// resulting signal as prescribed by the supplied function.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink = Sink::new();</span> + <span class='doccomment'>/// let sum = sink.stream().scan(0, |a, b| a + b);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 0);</span> + <span class='doccomment'>/// sink.send(2);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 2);</span> + <span class='doccomment'>/// sink.send(4);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 6);</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>scan</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>initial</span>: <span class='ident'>B</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Signal</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>B</span>, <span class='ident'>A</span>) <span class='op'>-></span> <span class='ident'>B</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='ident'>Signal</span>::<span class='ident'>cyclic</span>(<span class='op'>|</span><span class='ident'>scan</span><span class='op'>|</span> <span class='ident'>scan</span>.<span class='ident'>snapshot</span>(<span class='self'>self</span>, <span class='ident'>f</span>).<span class='ident'>hold</span>(<span class='ident'>initial</span>)) + } + + <span class='doccomment'>/// Scan a stream and accumulate its event firings in some mutable state.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// Semantically this is equivalent to `scan`. However, it allows one to use</span> + <span class='doccomment'>/// a non-Clone type as an accumulator and update it with efficient in-place</span> + <span class='doccomment'>/// operations.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// The resulting `SignalMut` does have a slightly different API from a</span> + <span class='doccomment'>/// regular `Signal` as it does not allow clones.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// # Example</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::{ Sink, Signal };</span> + <span class='doccomment'>/// let sink: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let sum = sink.stream()</span> + <span class='doccomment'>/// .scan_mut(0, |sum, a| *sum += a)</span> + <span class='doccomment'>/// .combine(&Signal::new(()), |sum, ()| *sum);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 0);</span> + <span class='doccomment'>/// sink.send(2);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 2);</span> + <span class='doccomment'>/// sink.send(4);</span> + <span class='doccomment'>/// assert_eq!(sum.sample(), 6);</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>scan_mut</span><span class='op'><</span><span class='ident'>B</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>initial</span>: <span class='ident'>B</span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>SignalMut</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>B</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>B</span>, <span class='ident'>A</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='ident'>signal</span>::<span class='ident'>scan_mut</span>(<span class='self'>self</span>, <span class='ident'>initial</span>, <span class='ident'>f</span>) + } +} + +<span class='kw'>impl</span><span class='op'><</span><span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>Stream</span><span class='op'><</span><span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span> { + <span class='doccomment'>/// Filter a stream of options.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// `filter_some` creates a new stream that only fires the unwrapped</span> + <span class='doccomment'>/// `Some(…)` events from the original stream omitting any `None` events.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::Sink;</span> + <span class='doccomment'>/// let sink = Sink::new();</span> + <span class='doccomment'>/// let mut events = sink.stream().filter_some().events();</span> + <span class='doccomment'>/// sink.send(None); // won't arrive</span> + <span class='doccomment'>/// sink.send(Some(5)); // will arrive</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(5));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>filter_some</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>() + .<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='ident'>a</span>.<span class='ident'>map_or</span>( + <span class='prelude-val'>Ok</span>(()), + <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>a</span>)) + )); + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>src</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>clone</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'>Stream</span><span class='op'><</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>>></span> { + <span class='doccomment'>/// Switch between streams.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// This takes a stream of streams and maps it to a new stream, which fires</span> + <span class='doccomment'>/// all events from the most recent stream fired into it.</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// # Example</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// ```</span> + <span class='doccomment'>/// # use carboxyl::{ Sink, Stream };</span> + <span class='doccomment'>/// // Create sinks</span> + <span class='doccomment'>/// let stream_sink: Sink<Stream<i32>> = Sink::new();</span> + <span class='doccomment'>/// let sink1: Sink<i32> = Sink::new();</span> + <span class='doccomment'>/// let sink2: Sink<i32> = Sink::new();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Switch and listen</span> + <span class='doccomment'>/// let switched = stream_sink.stream().switch();</span> + <span class='doccomment'>/// let mut events = switched.events();</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Should not receive events from either sink</span> + <span class='doccomment'>/// sink1.send(1); sink2.send(2);</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // Now switch to sink 2</span> + <span class='doccomment'>/// stream_sink.send(sink2.stream());</span> + <span class='doccomment'>/// sink1.send(3); sink2.send(4);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(4));</span> + <span class='doccomment'>///</span> + <span class='doccomment'>/// // And then to sink 1</span> + <span class='doccomment'>/// stream_sink.send(sink1.stream());</span> + <span class='doccomment'>/// sink1.send(5); sink2.send(6);</span> + <span class='doccomment'>/// assert_eq!(events.next(), Some(5));</span> + <span class='doccomment'>/// ```</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>switch</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>rewire_callbacks</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>(<span class='ident'>new_stream</span>: <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>source</span>: <span class='ident'>Weak</span><span class='op'><</span><span class='ident'>RwLock</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='op'>></span>, + <span class='ident'>terminate</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>Arc</span><span class='op'><</span>()<span class='op'>></span>) + <span class='op'>-></span> <span class='ident'>CallbackResult</span> + <span class='kw'>where</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'>terminate</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(()); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>terminate</span>.<span class='ident'>downgrade</span>(); + <span class='ident'>new_stream</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>register</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</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='op'>|</span> <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>source</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>a</span>))) + ); + <span class='prelude-val'>Ok</span>(()) + } + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='self'>self</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>register</span>({ + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>terminate</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(()); + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>stream</span><span class='op'>|</span> <span class='ident'>rewire_callbacks</span>(<span class='ident'>stream</span>, <span class='ident'>weak</span>.<span class='ident'>clone</span>(), <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>terminate</span>) + }); + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>src</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='self'>self</span>.<span class='ident'>clone</span>()), + } + }) + } +} + + +<span class='doccomment'>/// Make a snapshot of a signal, whenever a stream fires an event.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>snapshot</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>B</span>, <span class='ident'>C</span>, <span class='ident'>F</span><span class='op'>></span>(<span class='ident'>signal</span>: <span class='kw-2'>&</span><span class='ident'>Signal</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, <span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>B</span><span class='op'>></span>, <span class='ident'>f</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>Stream</span><span class='op'><</span><span class='ident'>C</span><span class='op'>></span> + <span class='kw'>where</span> <span class='ident'>A</span>: <span class='ident'>Clone</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='ident'>B</span>: <span class='ident'>Clone</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='ident'>C</span>: <span class='ident'>Clone</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='ident'>F</span>: <span class='ident'>Fn</span>(<span class='ident'>A</span>, <span class='ident'>B</span>) <span class='op'>-></span> <span class='ident'>C</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='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> <span class='ident'>src</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='ident'>Source</span>::<span class='ident'>new</span>())); + <span class='kw'>let</span> <span class='ident'>weak</span> <span class='op'>=</span> <span class='ident'>src</span>.<span class='ident'>downgrade</span>(); + <span class='ident'>stream</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>register</span>({ + <span class='kw'>let</span> <span class='ident'>signal</span> <span class='op'>=</span> <span class='ident'>signal</span>.<span class='ident'>clone</span>(); + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>b</span><span class='op'>|</span> <span class='ident'>with_weak</span>(<span class='kw-2'>&</span><span class='ident'>weak</span>, <span class='op'>|</span><span class='ident'>src</span><span class='op'>|</span> <span class='ident'>src</span>.<span class='ident'>send</span>(<span class='ident'>f</span>(<span class='ident'>sample_raw</span>(<span class='kw-2'>&</span><span class='ident'>signal</span>), <span class='ident'>b</span>))) + }); + <span class='ident'>Stream</span> { + <span class='ident'>source</span>: <span class='ident'>src</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>((<span class='ident'>stream</span>.<span class='ident'>clone</span>(), <span class='ident'>signal</span>.<span class='ident'>clone</span>())), + } + }) +} + + +<span class='doccomment'>/// A blocking iterator over events in a stream.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Events</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>receiver</span>: <span class='ident'>Receiver</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>, + <span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>dead_code</span>)]</span> + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span><span class='op'><</span><span class='ident'>BoxClone</span><span class='op'>></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='lifetime'>'static</span><span class='op'>></span> <span class='ident'>Events</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='doccomment'>/// Create a new events iterator.</span> + <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>stream</span>: <span class='kw-2'>&</span><span class='ident'>Stream</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span>) <span class='op'>-></span> <span class='ident'>Events</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='kw'>let</span> (<span class='ident'>tx</span>, <span class='ident'>rx</span>) <span class='op'>=</span> <span class='ident'>channel</span>(); + <span class='kw'>let</span> <span class='ident'>tx</span> <span class='op'>=</span> <span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='ident'>tx</span>); + <span class='ident'>stream</span>.<span class='ident'>source</span>.<span class='ident'>write</span>().<span class='ident'>unwrap</span>().<span class='ident'>register</span>( + <span class='kw'>move</span> <span class='op'>|</span><span class='ident'>a</span><span class='op'>|</span> <span class='ident'>tx</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>().<span class='ident'>send</span>(<span class='ident'>a</span>).<span class='ident'>map_err</span>(<span class='op'>|</span>_<span class='op'>|</span> <span class='ident'>CallbackError</span>::<span class='ident'>Disappeared</span>) + ); + <span class='ident'>Events</span> { + <span class='ident'>receiver</span>: <span class='ident'>rx</span>, + <span class='ident'>keep_alive</span>: <span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>stream</span>.<span class='ident'>clone</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='lifetime'>'static</span><span class='op'>></span> <span class='ident'>Iterator</span> <span class='kw'>for</span> <span class='ident'>Events</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { + <span class='kw'>type</span> <span class='ident'>Item</span> <span class='op'>=</span> <span class='ident'>A</span>; + <span class='kw'>fn</span> <span class='ident'>next</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>A</span><span class='op'>></span> { <span class='self'>self</span>.<span class='ident'>receiver</span>.<span class='ident'>recv</span>().<span class='ident'>ok</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'>thread</span>; + <span class='kw'>use</span> <span class='ident'>quickcheck</span>::<span class='ident'>quickcheck</span>; + + <span class='kw'>use</span> <span class='ident'>testing</span>::{ <span class='ident'>id</span>, <span class='ident'>stream_eq</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'>sink</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>2</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>1</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>map</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>triple</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='number'>3</span> <span class='op'>*</span> <span class='ident'>x</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>triple</span>.<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>3</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>filter_some</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>small</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>filter_some</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>small</span>.<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='prelude-val'>None</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='prelude-val'>Some</span>(<span class='number'>9</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>9</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>chain_1</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span>: <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>chain</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>() + .<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'>/</span> <span class='number'>2</span>) + .<span class='ident'>filter</span>(<span class='op'>|</span><span class='kw-2'>&</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'><</span> <span class='number'>3</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>chain</span>.<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>7</span>); + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>4</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>merge</span>() { + <span class='kw'>let</span> <span class='ident'>sink1</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink2</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink1</span>.<span class='ident'>stream</span>().<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>sink2</span>.<span class='ident'>stream</span>()).<span class='ident'>events</span>(); + <span class='ident'>sink1</span>.<span class='ident'>send</span>(<span class='number'>12</span>); + <span class='ident'>sink2</span>.<span class='ident'>send</span>(<span class='number'>9</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>12</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>9</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>chain_2</span>() { + <span class='kw'>let</span> <span class='ident'>sink1</span>: <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink2</span>: <span class='ident'>Sink</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink1</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'>+</span> <span class='number'>4</span>) + .<span class='ident'>merge</span>( + <span class='kw-2'>&</span><span class='ident'>sink2</span>.<span class='ident'>stream</span>() + .<span class='ident'>filter_map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='kw'>if</span> <span class='ident'>x</span> <span class='op'><</span> <span class='number'>4</span> { <span class='prelude-val'>Some</span>(<span class='ident'>x</span>) } <span class='kw'>else</span> { <span class='prelude-val'>None</span> }) + .<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>x</span><span class='op'>|</span> <span class='ident'>x</span> <span class='op'>*</span> <span class='number'>5</span>)) + .<span class='ident'>events</span>(); + <span class='ident'>sink1</span>.<span class='ident'>send</span>(<span class='number'>12</span>); + <span class='ident'>sink2</span>.<span class='ident'>send</span>(<span class='number'>3</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>16</span>)); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>15</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>move_closure</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='number'>3</span>; + <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>map</span>(<span class='kw'>move</span> <span class='op'>|</span><span class='ident'>y</span><span class='op'>|</span> <span class='ident'>y</span> <span class='op'>+</span> <span class='ident'>x</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>scan_race_condition</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='comment'>// Feed the sink in the background</span> + <span class='ident'>sink</span>.<span class='ident'>feed_async</span>(<span class='number'>0</span>..<span class='number'>100000</span>); + <span class='comment'>// Try it multiple times to increase failure probability, when a data</span> + <span class='comment'>// race can potentially happen.</span> + <span class='kw'>for</span> _ <span class='kw'>in</span> <span class='number'>0</span>..<span class='number'>10</span> { + <span class='kw'>let</span> <span class='ident'>_sum</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>scan</span>(<span class='number'>0</span>, <span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>a</span> <span class='op'>+</span> <span class='ident'>b</span>); + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>sink_send_async</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>send_async</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>1</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>sink_feed</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>feed</span>(<span class='number'>0</span>..<span class='number'>10</span>); + <span class='kw'>for</span> (<span class='ident'>n</span>, <span class='ident'>m</span>) <span class='kw'>in</span> <span class='ident'>events</span>.<span class='ident'>take</span>(<span class='number'>10</span>).<span class='ident'>enumerate</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>n</span> <span class='kw'>as</span> <span class='ident'>i32</span>, <span class='ident'>m</span>); + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>sink_feed_async</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>().<span class='ident'>events</span>(); + <span class='ident'>sink</span>.<span class='ident'>feed_async</span>(<span class='number'>0</span>..<span class='number'>10</span>); + <span class='kw'>for</span> (<span class='ident'>n</span>, <span class='ident'>m</span>) <span class='kw'>in</span> <span class='ident'>events</span>.<span class='ident'>take</span>(<span class='number'>10</span>).<span class='ident'>enumerate</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>n</span> <span class='kw'>as</span> <span class='ident'>i32</span>, <span class='ident'>m</span>); + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>coalesce</span>() { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>() + .<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>sink</span>.<span class='ident'>stream</span>()) + .<span class='ident'>coalesce</span>(<span class='op'>|</span><span class='ident'>a</span>, <span class='ident'>b</span><span class='op'>|</span> <span class='ident'>a</span> <span class='op'>+</span> <span class='ident'>b</span>); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>events</span> <span class='op'>=</span> <span class='ident'>stream</span>.<span class='ident'>events</span>(); + + <span class='ident'>sink</span>.<span class='ident'>send</span>(<span class='number'>1</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>events</span>.<span class='ident'>next</span>(), <span class='prelude-val'>Some</span>(<span class='number'>2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>monoid_left_identity</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>input</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>stream_eq</span>(<span class='kw-2'>&</span><span class='ident'>Stream</span>::<span class='ident'>never</span>().<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>a</span>), <span class='kw-2'>&</span><span class='ident'>a</span>); + <span class='ident'>sink</span>.<span class='ident'>feed</span>(<span class='ident'>input</span>.<span class='ident'>into_iter</span>()); + <span class='ident'>eq</span>.<span class='ident'>sample</span>() + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>monoid_right_identity</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>input</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>stream_eq</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>Stream</span>::<span class='ident'>never</span>()), <span class='kw-2'>&</span><span class='ident'>a</span>); + <span class='ident'>sink</span>.<span class='ident'>feed</span>(<span class='ident'>input</span>.<span class='ident'>into_iter</span>()); + <span class='ident'>eq</span>.<span class='ident'>sample</span>() + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>monoid_associative</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>input_a</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>, <span class='ident'>input_b</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>, <span class='ident'>input_c</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>sink_a</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink_b</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>sink_c</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>sink_a</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>sink_b</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>sink_c</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>stream_eq</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>b</span>.<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>c</span>)), <span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>b</span>).<span class='ident'>merge</span>(<span class='kw-2'>&</span><span class='ident'>c</span>)); + <span class='comment'>/* feed in parallel */</span> { + <span class='kw'>let</span> <span class='ident'>_g1</span> <span class='op'>=</span> <span class='ident'>thread</span>::<span class='ident'>scoped</span>(<span class='op'>||</span> <span class='ident'>sink_a</span>.<span class='ident'>feed</span>(<span class='ident'>input_a</span>.<span class='ident'>into_iter</span>())); + <span class='kw'>let</span> <span class='ident'>_g2</span> <span class='op'>=</span> <span class='ident'>thread</span>::<span class='ident'>scoped</span>(<span class='op'>||</span> <span class='ident'>sink_b</span>.<span class='ident'>feed</span>(<span class='ident'>input_b</span>.<span class='ident'>into_iter</span>())); + <span class='kw'>let</span> <span class='ident'>_g3</span> <span class='op'>=</span> <span class='ident'>thread</span>::<span class='ident'>scoped</span>(<span class='op'>||</span> <span class='ident'>sink_c</span>.<span class='ident'>feed</span>(<span class='ident'>input_c</span>.<span class='ident'>into_iter</span>())); + } + <span class='ident'>eq</span>.<span class='ident'>sample</span>() + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>, <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>, <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>functor_identity</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>input</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span> { + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>stream_eq</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>map</span>(<span class='ident'>id</span>), <span class='kw-2'>&</span><span class='ident'>a</span>); + <span class='ident'>sink</span>.<span class='ident'>feed</span>(<span class='ident'>input</span>.<span class='ident'>into_iter</span>()); + <span class='ident'>eq</span>.<span class='ident'>sample</span>() + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>functor_composition</span>() { + <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>input</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></span> { + <span class='kw'>fn</span> <span class='ident'>f</span>(<span class='ident'>n</span>: <span class='ident'>i32</span>) <span class='op'>-></span> <span class='ident'>i64</span> { (<span class='ident'>n</span> <span class='op'>+</span> <span class='number'>3</span>) <span class='kw'>as</span> <span class='ident'>i64</span> } + <span class='kw'>fn</span> <span class='ident'>g</span>(<span class='ident'>n</span>: <span class='ident'>i64</span>) <span class='op'>-></span> <span class='ident'>f64</span> { <span class='ident'>n</span> <span class='kw'>as</span> <span class='ident'>f64</span> <span class='op'>/</span> <span class='number'>2.5</span> } + + <span class='kw'>let</span> <span class='ident'>sink</span> <span class='op'>=</span> <span class='ident'>Sink</span>::<span class='ident'>new</span>(); + <span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>sink</span>.<span class='ident'>stream</span>(); + <span class='kw'>let</span> <span class='ident'>eq</span> <span class='op'>=</span> <span class='ident'>stream_eq</span>(<span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>map</span>(<span class='ident'>f</span>).<span class='ident'>map</span>(<span class='ident'>g</span>), <span class='kw-2'>&</span><span class='ident'>a</span>.<span class='ident'>map</span>(<span class='op'>|</span><span class='ident'>n</span><span class='op'>|</span> <span class='ident'>g</span>(<span class='ident'>f</span>(<span class='ident'>n</span>)))); + <span class='ident'>sink</span>.<span class='ident'>feed</span>(<span class='ident'>input</span>.<span class='ident'>into_iter</span>()); + <span class='ident'>eq</span>.<span class='ident'>sample</span>() + } + <span class='ident'>quickcheck</span>(<span class='ident'>check</span> <span class='kw'>as</span> <span class='kw'>fn</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>bool</span>, <span class='ident'>String</span><span class='op'>></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 diff --git a/src/carboxyl/transaction.rs.html b/src/carboxyl/transaction.rs.html new file mode 100644 index 0000000..e9cc7b6 --- /dev/null +++ b/src/carboxyl/transaction.rs.html @@ -0,0 +1,459 @@ +<!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/transaction.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>transaction.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> +<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> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +</pre><pre class='rust '> +<span class='doccomment'>//! A trivial global lock transaction system.</span> +<span class='doccomment'>//!</span> +<span class='doccomment'>//! At the moment, this is really just a global static mutex, that needs to be</span> +<span class='doccomment'>//! locked, to ensure the atomicity of a transaction.</span> + +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>Mutex</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cell</span>::<span class='ident'>RefCell</span>; +<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>boxed</span>::<span class='ident'>FnBox</span>; + + +<span class='doccomment'>/// The global transaction lock.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// TODO: revert this to use a static mutex, as soon as that is stabilized in</span> +<span class='doccomment'>/// the standard library.</span> +<span class='macro'>lazy_static</span><span class='macro'>!</span> { + <span class='kw'>static</span> <span class='kw-2'>ref</span> <span class='ident'>TRANSACTION_MUTEX</span>: <span class='ident'>Mutex</span><span class='op'><</span>()<span class='op'>></span> <span class='op'>=</span> <span class='ident'>Mutex</span>::<span class='ident'>new</span>(()); +} + +<span class='doccomment'>/// Registry for callbacks to be executed at the end of a transaction.</span> +<span class='macro'>thread_local</span><span class='macro'>!</span>( + <span class='kw'>static</span> <span class='ident'>CURRENT_TRANSACTION</span>: <span class='ident'>RefCell</span><span class='op'><</span><span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>Transaction</span><span class='op'>>></span> <span class='op'>=</span> + <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='prelude-val'>None</span>) +); + + +<span class='doccomment'>/// A callback.</span> +<span class='kw'>type</span> <span class='ident'>Callback</span> <span class='op'>=</span> <span class='ident'>Box</span><span class='op'><</span><span class='ident'>FnBox</span>() <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span>; + + +<span class='doccomment'>/// A transaction.</span> +<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Transaction</span> { + <span class='ident'>intermediate</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Callback</span><span class='op'>></span>, + <span class='ident'>finalizers</span>: <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Callback</span><span class='op'>></span>, +} + +<span class='kw'>impl</span> <span class='ident'>Transaction</span> { + <span class='doccomment'>/// Create a new transaction</span> + <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>Transaction</span> { + <span class='ident'>Transaction</span> { + <span class='ident'>intermediate</span>: <span class='macro'>vec</span><span class='macro'>!</span>[], + <span class='ident'>finalizers</span>: <span class='macro'>vec</span><span class='macro'>!</span>[], + } + } + + <span class='doccomment'>/// Add a callback that will be called, when the transaction is done</span> + <span class='doccomment'>/// except for finalizers.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>later</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>FnOnce</span>() <span class='op'>+</span> <span class='lifetime'>'static</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='self'>self</span>.<span class='ident'>intermediate</span>.<span class='ident'>push</span>(<span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>callback</span>)); + } + + <span class='doccomment'>/// Add a finalizing callback. This should not have far reaching</span> + <span class='doccomment'>/// side-effects, and in particular not commit by itself. Typical operations</span> + <span class='doccomment'>/// for a finalizer are executing queued state updates.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>end</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>FnOnce</span>() <span class='op'>+</span> <span class='lifetime'>'static</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='self'>self</span>.<span class='ident'>finalizers</span>.<span class='ident'>push</span>(<span class='ident'>Box</span>::<span class='ident'>new</span>(<span class='ident'>callback</span>)); + } + + <span class='doccomment'>/// Advance transactions by moving out intermediate stage callbacks.</span> + <span class='kw'>fn</span> <span class='ident'>advance</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>Vec</span><span class='op'><</span><span class='ident'>Callback</span><span class='op'>></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'>intermediate</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'>intermediate</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='ident'>intermediate</span>); + <span class='ident'>intermediate</span> + } + + <span class='doccomment'>/// Finalize the transaction</span> + <span class='kw'>fn</span> <span class='ident'>finalize</span>(<span class='self'>self</span>) { + <span class='kw'>for</span> <span class='ident'>finalizer</span> <span class='kw'>in</span> <span class='self'>self</span>.<span class='ident'>finalizers</span> { + <span class='ident'>finalizer</span>.<span class='ident'>call_box</span>(()); + } + } +} + + +<span class='doccomment'>/// Commit a transaction.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// If the thread is not running any transactions currently, the global lock is</span> +<span class='doccomment'>/// acquired. Otherwise a new transaction begins, since given the interface of</span> +<span class='doccomment'>/// this module it is safely assumed that the lock is already held.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>commit</span><span class='op'><</span><span class='ident'>A</span>, <span class='ident'>F</span>: <span class='ident'>FnOnce</span>() <span class='op'>-></span> <span class='ident'>A</span><span class='op'>></span>(<span class='ident'>body</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>A</span> { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>mem</span>; + <span class='comment'>// Begin a new transaction</span> + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>prev</span> <span class='op'>=</span> <span class='ident'>CURRENT_TRANSACTION</span>.<span class='ident'>with</span>(<span class='op'>|</span><span class='ident'>current</span><span class='op'>|</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>prev</span> <span class='op'>=</span> <span class='prelude-val'>Some</span>(<span class='ident'>Transaction</span>::<span class='ident'>new</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'>prev</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>current</span>.<span class='ident'>borrow_mut</span>()); + <span class='ident'>prev</span> + }); + <span class='comment'>// Acquire global lock if necessary</span> + <span class='kw'>let</span> <span class='ident'>_lock</span> <span class='op'>=</span> <span class='kw'>match</span> <span class='ident'>prev</span> { + <span class='prelude-val'>None</span> <span class='op'>=></span> <span class='prelude-val'>Some</span>(<span class='ident'>TRANSACTION_MUTEX</span>.<span class='ident'>lock</span>().<span class='ident'>ok</span>() + .<span class='ident'>expect</span>(<span class='string'>"global transaction mutex poisoned"</span>) + ), + <span class='prelude-val'>Some</span>(_) <span class='op'>=></span> <span class='prelude-val'>None</span>, + }; + <span class='comment'>// Perform the main body of the transaction</span> + <span class='kw'>let</span> <span class='ident'>result</span> <span class='op'>=</span> <span class='ident'>body</span>(); + <span class='comment'>// Advance the transaction as long as necessary</span> + <span class='kw'>loop</span> { + <span class='kw'>let</span> <span class='ident'>callbacks</span> <span class='op'>=</span> <span class='ident'>with_current</span>(<span class='ident'>Transaction</span>::<span class='ident'>advance</span>); + <span class='kw'>if</span> <span class='ident'>callbacks</span>.<span class='ident'>is_empty</span>() { <span class='kw'>break</span> } + <span class='kw'>for</span> <span class='ident'>callback</span> <span class='kw'>in</span> <span class='ident'>callbacks</span> { + <span class='ident'>callback</span>.<span class='ident'>call_box</span>(()); + } + } + <span class='comment'>// Call all finalizers and drop the transaction</span> + <span class='ident'>CURRENT_TRANSACTION</span>.<span class='ident'>with</span>(<span class='op'>|</span><span class='ident'>current</span><span class='op'>|</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'>prev</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>current</span>.<span class='ident'>borrow_mut</span>()) + ); + <span class='ident'>prev</span>.<span class='ident'>unwrap</span>().<span class='ident'>finalize</span>(); + <span class='comment'>// Return</span> + <span class='ident'>result</span> +} + + +<span class='doccomment'>/// Register a callback during a transaction.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>with_current</span><span class='op'><</span><span class='ident'>A</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'>Transaction</span>) <span class='op'>-></span> <span class='ident'>A</span><span class='op'>></span>(<span class='ident'>action</span>: <span class='ident'>F</span>) <span class='op'>-></span> <span class='ident'>A</span> { + <span class='ident'>CURRENT_TRANSACTION</span>.<span class='ident'>with</span>(<span class='op'>|</span><span class='ident'>current</span><span class='op'>|</span> + <span class='kw'>match</span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='op'>*</span><span class='ident'>current</span>.<span class='ident'>borrow_mut</span>() { + <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='prelude-val'>Some</span>(<span class='kw-2'>ref</span> <span class='kw-2'>mut</span> <span class='ident'>trans</span>) <span class='op'>=></span> <span class='ident'>action</span>(<span class='ident'>trans</span>), + _ <span class='op'>=></span> <span class='macro'>panic</span><span class='macro'>!</span>(<span class='string'>"there is no active transaction to register a callback"</span>), + } + ) +} + +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>later</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>FnOnce</span>() <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span>(<span class='ident'>action</span>: <span class='ident'>F</span>) { + <span class='ident'>with_current</span>(<span class='op'>|</span><span class='ident'>c</span><span class='op'>|</span> <span class='ident'>c</span>.<span class='ident'>later</span>(<span class='ident'>action</span>)) +} + +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>end</span><span class='op'><</span><span class='ident'>F</span>: <span class='ident'>FnOnce</span>() <span class='op'>+</span> <span class='lifetime'>'static</span><span class='op'>></span>(<span class='ident'>action</span>: <span class='ident'>F</span>) { + <span class='ident'>with_current</span>(<span class='op'>|</span><span class='ident'>c</span><span class='op'>|</span> <span class='ident'>c</span>.<span class='ident'>end</span>(<span class='ident'>action</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'>super</span>::<span class='op'>*</span>; + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>commit_single</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='number'>3</span>; + <span class='ident'>commit</span>(<span class='op'>||</span> <span class='ident'>v</span> <span class='op'>+=</span> <span class='number'>5</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>v</span>, <span class='number'>8</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>commit_nested</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='number'>3</span>; + <span class='ident'>commit</span>(<span class='op'>||</span> { + <span class='ident'>commit</span>(<span class='op'>||</span> <span class='ident'>v</span> <span class='op'>*=</span> <span class='number'>2</span>); + <span class='ident'>v</span> <span class='op'>+=</span> <span class='number'>4</span>; + }); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>v</span>, <span class='number'>10</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>commits_parallel</span>() { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::{<span class='ident'>Arc</span>, <span class='ident'>Mutex</span>}; + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>; + + <span class='comment'>// Set up a ref-counted value</span> + <span class='kw'>let</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>Arc</span>::<span class='ident'>new</span>(<span class='ident'>Mutex</span>::<span class='ident'>new</span>(<span class='number'>3</span>)); + <span class='comment'>// Spawn a couple of scoped threads performing atomic operations on it</span> + <span class='kw'>let</span> <span class='ident'>guards</span>: <span class='ident'>Vec</span><span class='op'><</span>_<span class='op'>></span> <span class='op'>=</span> (<span class='number'>0</span>..<span class='number'>3</span>) + .<span class='ident'>map</span>(<span class='op'>|</span>_<span class='op'>|</span> { + <span class='kw'>let</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>v</span>.<span class='ident'>clone</span>(); + <span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> <span class='ident'>commit</span>(<span class='kw'>move</span> <span class='op'>||</span> { + <span class='comment'>// Acquire locks independently, s.t. commit atomicity does</span> + <span class='comment'>// not rely on the local locks here</span> + <span class='op'>*</span><span class='ident'>v</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>() <span class='op'>*=</span> <span class='number'>2</span>; + <span class='comment'>// …and sleep for a bit</span> + <span class='ident'>thread</span>::<span class='ident'>sleep_ms</span>(<span class='number'>1</span>); + <span class='op'>*</span><span class='ident'>v</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>() <span class='op'>-=</span> <span class='number'>1</span>; + })) + }) + .<span class='ident'>collect</span>(); + <span class='comment'>// Rejoin with all guards</span> + <span class='kw'>for</span> <span class='ident'>guard</span> <span class='kw'>in</span> <span class='ident'>guards</span> { <span class='ident'>guard</span>.<span class='ident'>join</span>().<span class='ident'>ok</span>().<span class='ident'>expect</span>(<span class='string'>"thread failed"</span>); } + <span class='comment'>// Check result</span> + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='kw-2'>&</span><span class='op'>*</span><span class='ident'>v</span>.<span class='ident'>lock</span>().<span class='ident'>unwrap</span>(), <span class='kw-2'>&</span><span class='number'>17</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 |