<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../spin_sync/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">// Copyright 2020 Shin Yoshida</span>
<span class="comment">//</span>
<span class="comment">// "LGPL-3.0-or-later OR Apache-2.0 OR BSD-2-Clause"</span>
<span class="comment">//</span>
<span class="comment">// This is part of spin-sync</span>
<span class="comment">//</span>
<span class="comment">// spin-sync is free software: you can redistribute it and/or modify</span>
<span class="comment">// it under the terms of the GNU Lesser General Public License as published by</span>
<span class="comment">// the Free Software Foundation, either version 3 of the License, or</span>
<span class="comment">// (at your option) any later version.</span>
<span class="comment">//</span>
<span class="comment">// spin-sync is distributed in the hope that it will be useful,</span>
<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="comment">// GNU Lesser General Public License for more details.</span>
<span class="comment">//</span>
<span class="comment">// You should have received a copy of the GNU Lesser General Public License</span>
<span class="comment">// along with spin-sync. If not, see <http://www.gnu.org/licenses/>.</span>
<span class="comment">//</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="comment">// you may not use this file except in compliance with the License.</span>
<span class="comment">// You may obtain a copy of the License at</span>
<span class="comment">//</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="comment">//</span>
<span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
<span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="comment">// See the License for the specific language governing permissions and</span>
<span class="comment">// limitations under the License.</span>
<span class="comment">//</span>
<span class="comment">//</span>
<span class="comment">// Redistribution and use in source and binary forms, with or without modification, are permitted</span>
<span class="comment">// provided that the following conditions are met:</span>
<span class="comment">//</span>
<span class="comment">// 1. Redistributions of source code must retain the above copyright notice, this list of</span>
<span class="comment">// conditions and the following disclaimer.</span>
<span class="comment">// 2. Redistributions in binary form must reproduce the above copyright notice, this</span>
<span class="comment">// list of conditions and the following disclaimer in the documentation and/or other</span>
<span class="comment">// materials provided with the distribution.</span>
<span class="comment">//</span>
<span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND</span>
<span class="comment">// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
<span class="comment">// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.</span>
<span class="comment">// IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,</span>
<span class="comment">// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT</span>
<span class="comment">// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span>
<span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
<span class="comment">// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span>
<span class="comment">// POSSIBILITY OF SUCH DAMAGE.</span>
<span class="doccomment">//! [](https://circleci.com/gh/wbcchsyn/spin-sync-rs)</span>
<span class="doccomment">//! [](https://travis-ci.org/wbcchsyn/spin-sync-rs)</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! spin-sync is a module providing synchronization primitives using spinlock. ([Wikipedia Spinlock](https://en.wikipedia.org/wiki/Spinlock))</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The main features are as follows.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! * Declaring public structs `Mutex` , `RwLock` , `Once` , `Barrier` . The interfaces are resembles those of `std::sync` .</span>
<span class="doccomment">//! * Ensuring safety as much as `std::sync` , including poisoning strategy and marker traits.</span>
<span class="doccomment">//! * Declaring public struct `Mutex8` , which behaves like a set of 8 `Mutex` instances except for</span>
<span class="doccomment">//! it gives up poison strategy. It is possible to acquire 2 or more than 2 locks of 1 `Mutex8`</span>
<span class="doccomment">//! instance at once.</span>
<span class="doccomment">//! * Unlike to `std::sync`, the constructors of the public structs are const. For example, it is</span>
<span class="doccomment">//! possible to declare static `Mutex<T>` as long as T can be build statically.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Examples</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Declare `static spin_sync::Mutex<u64>` variable and update from multi threads.</span>
<span class="doccomment">//! It is impossible in case of `std::sync::Mutex` .</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! extern crate spin_sync;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! use spin_sync::Mutex;</span>
<span class="doccomment">//! use std::thread;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // Declare static mut Mutex<u64> variable.</span>
<span class="doccomment">//! static COUNT: Mutex<u64> = Mutex::new(0);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn main() {</span>
<span class="doccomment">//! let num_thread = 10;</span>
<span class="doccomment">//! let mut handles = Vec::new();</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! // Create worker threads to inclement COUNT by 1.</span>
<span class="doccomment">//! for _ in 0..10 {</span>
<span class="doccomment">//! let handle = thread::spawn(move || {</span>
<span class="doccomment">//! let mut count = COUNT.lock().unwrap();</span>
<span class="doccomment">//! *count += 1;</span>
<span class="doccomment">//! });</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! handles.push(handle);</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // Wait for all the workers.</span>
<span class="doccomment">//! for handle in handles {</span>
<span class="doccomment">//! handle.join().unwrap();</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // Make sure the value is incremented by the worker count.</span>
<span class="doccomment">//! let count = COUNT.lock().unwrap();</span>
<span class="doccomment">//! assert_eq!(num_thread, *count);</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="kw">mod</span> <span class="ident">barrier</span>;
<span class="kw">mod</span> <span class="ident">misc</span>;
<span class="kw">mod</span> <span class="ident">mutex</span>;
<span class="kw">mod</span> <span class="ident">mutex8</span>;
<span class="kw">mod</span> <span class="ident">once</span>;
<span class="kw">mod</span> <span class="ident">result</span>;
<span class="kw">mod</span> <span class="ident">rwlock</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">barrier</span>::{<span class="ident">Barrier</span>, <span class="ident">BarrierWaitResult</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">mutex</span>::{<span class="ident">Mutex</span>, <span class="ident">MutexGuard</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">mutex8</span>::{<span class="ident">Mutex8</span>, <span class="ident">Mutex8Guard</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">once</span>::{<span class="ident">Once</span>, <span class="ident">OnceState</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">result</span>::{<span class="ident">LockResult</span>, <span class="ident">PoisonError</span>, <span class="ident">TryLockError</span>, <span class="ident">TryLockResult</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">rwlock</span>::{<span class="ident">RwLock</span>, <span class="ident">RwLockReadGuard</span>, <span class="ident">RwLockWriteGuard</span>};
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "spin_sync";</script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>