diff options
Diffstat (limited to 'src/carboxyl/readonly.rs.html')
| -rw-r--r-- | src/carboxyl/readonly.rs.html | 173 |
1 files changed, 173 insertions, 0 deletions
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 |