178 lines
No EOL
16 KiB
HTML
178 lines
No EOL
16 KiB
HTML
<!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` struct in crate `lazycell`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, LazyCell">
|
||
|
||
<title>lazycell::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 struct">
|
||
<!--[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>
|
||
|
||
<p class='location'>Struct LazyCell</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.fill">fill</a><a href="#method.filled">filled</a><a href="#method.borrow">borrow</a><a href="#method.borrow_mut">borrow_mut</a><a href="#method.borrow_with">borrow_with</a><a href="#method.try_borrow_with">try_borrow_with</a><a href="#method.into_inner">into_inner</a><a href="#method.get">get</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div></div><p class='location'><a href='index.html'>lazycell</a></p><script>window.sidebarCurrent = {name: 'LazyCell', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Struct <a href='index.html'>lazycell</a>::<wbr><a class="struct" 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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/lazycell/lib.rs.html#52-54' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct LazyCell<T> { /* fields omitted */ }</pre><div class='docblock'><p>A lazily filled <code>Cell</code>, with frozen contents.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<T> <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#56-140' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#58-60' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new, empty, <code>LazyCell</code>.</p>
|
||
</div><h4 id='method.fill' class="method"><span id='fill.v' class='invisible'><code>pub fn <a href='#method.fill' class='fnname'>fill</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#65-73' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Put a value into this cell.</p>
|
||
<p>This function will return <code>Err(value)</code> is the cell is already full.</p>
|
||
</div><h4 id='method.filled' class="method"><span id='filled.v' class='invisible'><code>pub fn <a href='#method.filled' class='fnname'>filled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#76-78' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Test whether this cell has been previously filled.</p>
|
||
</div><h4 id='method.borrow' class="method"><span id='borrow.v' class='invisible'><code>pub fn <a href='#method.borrow' class='fnname'>borrow</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#85-87' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Borrows the contents of this lazy cell for the duration of the cell
|
||
itself.</p>
|
||
<p>This function will return <code>Some</code> if the cell has been previously
|
||
initialized, and <code>None</code> if it has not yet been initialized.</p>
|
||
</div><h4 id='method.borrow_mut' class="method"><span id='borrow_mut.v' class='invisible'><code>pub fn <a href='#method.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#94-96' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Borrows the contents of this lazy cell mutably for the duration of the cell
|
||
itself.</p>
|
||
<p>This function will return <code>Some</code> if the cell has been previously
|
||
initialized, and <code>None</code> if it has not yet been initialized.</p>
|
||
</div><h4 id='method.borrow_with' class="method"><span id='borrow_with.v' class='invisible'><code>pub fn <a href='#method.borrow_with' class='fnname'>borrow_with</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T>(&self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#107-116' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Borrows the contents of this lazy cell for the duration of the cell
|
||
itself.</p>
|
||
<p>If the cell has not yet been filled, the cell is first filled using the
|
||
function provided.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>Panics if the cell becomes filled as a side effect of <code>f</code>.</p>
|
||
</div><h4 id='method.try_borrow_with' class="method"><span id='try_borrow_with.v' class='invisible'><code>pub fn <a href='#method.try_borrow_with' class='fnname'>try_borrow_with</a><E, F>(&self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, E> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#123-134' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Same as <code>borrow_with</code>, but allows the initializing function to fail.</p>
|
||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
<p>Panics if the cell becomes filled as a side effect of <code>f</code>.</p>
|
||
</div><h4 id='method.into_inner' class="method"><span id='into_inner.v' class='invisible'><code>pub fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#137-139' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Consumes this <code>LazyCell</code>, returning the underlying value.</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>> <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#142-150' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#147-149' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the contents of the lazy cell.</p>
|
||
<p>This function will return <code>Some</code> if the cell has been previously initialized,
|
||
and <code>None</code> if it has not yet been initialized.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#51' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#51' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#51' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../lazycell/struct.LazyCell.html" title="struct lazycell::LazyCell">LazyCell</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/lazycell/lib.rs.html#51' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></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>⏎</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> |