mentat/lazycell/index.html
2018-08-22 17:04:13 +00:00

169 lines
No EOL
7.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `lazycell` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, lazycell">
<title>lazycell - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[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">&#9776;</div>
<p class='location'>Crate lazycell</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'lazycell', ty: 'mod', relpath: '../'};</script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>lazycell</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/lazycell/lib.rs.html#11-414' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>This crate provides a <code>LazyCell</code> struct which acts as a lazily filled
<code>Cell</code>, but with frozen contents.</p>
<p>With a <code>RefCell</code>, the inner contents cannot be borrowed for the lifetime of
the entire object, but only of the borrows returned. A <code>LazyCell</code> is a
variation on <code>RefCell</code> which allows borrows to be tied to the lifetime of
the outer object.</p>
<p>The limitation of a <code>LazyCell</code> is that after it is initialized and shared,
it can be modified.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<p>The following example shows a quick example of the basic functionality of
<code>LazyCell</code>.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">lazycell</span>::<span class="ident">LazyCell</span>;
<span class="kw">let</span> <span class="ident">lazycell</span> <span class="op">=</span> <span class="ident">LazyCell</span>::<span class="ident">new</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">lazycell</span>.<span class="ident">borrow</span>(), <span class="prelude-val">None</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">lazycell</span>.<span class="ident">filled</span>());
<span class="ident">lazycell</span>.<span class="ident">fill</span>(<span class="number">1</span>).<span class="ident">ok</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">lazycell</span>.<span class="ident">filled</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">lazycell</span>.<span class="ident">borrow</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">1</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">lazycell</span>.<span class="ident">into_inner</span>(), <span class="prelude-val">Some</span>(<span class="number">1</span>));</pre>
<p><code>AtomicLazyCell</code> is a variant that uses an atomic variable to manage
coordination in a thread-safe fashion.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.AtomicLazyCell.html"
title='struct lazycell::AtomicLazyCell'>AtomicLazyCell</a></td>
<td class='docblock-short'>
<p>A lazily filled <code>Cell</code>, with frozen contents.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.LazyCell.html"
title='struct lazycell::LazyCell'>LazyCell</a></td>
<td class='docblock-short'>
<p>A lazily filled <code>Cell</code>, with frozen contents.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "lazycell";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>