217 lines
No EOL
19 KiB
HTML
217 lines
No EOL
19 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 `RefCell` struct in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, RefCell">
|
||
|
||
<title>bitflags::__core::cell::RefCell - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<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]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>cell</a></p><script>window.sidebarCurrent = {name: 'RefCell', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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 struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>cell</a>::<wbr><a class='struct' href=''>RefCell</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 id='src-28178' class='srclink' href='https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html?gotosrc=28178' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct RefCell<T> <span class='where'>where T: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span> {
|
||
// some fields omitted
|
||
}</pre><span class="since">1.0.0</span><div class='docblock'><p>A mutable memory location with dynamically checked borrow rules</p>
|
||
|
||
<p>See the <a href="index.html">module-level documentation</a> for more.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl<T> <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h3><div class='impl-items'><h4 id='method.borrow_state' class='method'><code>fn <a href='#method.borrow_state' class='fnname'>borrow_state</a>(&self) -> <a class='enum' href='../../../bitflags/__core/cell/enum.BorrowState.html' title='bitflags::__core::cell::BorrowState'>BorrowState</a></code></h4>
|
||
<div class='stability'><em class='stab unstable'>Unstable (<code>borrow_state</code>)</em></div><div class='docblock'><p>Query the current state of this <code>RefCell</code></p>
|
||
|
||
<p>The returned value can be dispatched on to determine if a call to
|
||
<code>borrow</code> or <code>borrow_mut</code> would succeed.</p>
|
||
</div><h4 id='method.borrow' class='method'><code>fn <a href='#method.borrow' class='fnname'>borrow</a>(&self) -> <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a><T></code></h4>
|
||
<div class='docblock'><p>Immutably borrows the wrapped value.</p>
|
||
|
||
<p>The borrow lasts until the returned <code>Ref</code> exits scope. Multiple
|
||
immutable borrows can be taken out at the same time.</p>
|
||
|
||
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
|
||
<p>Panics if the value is currently mutably borrowed.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cell</span>::<span class='ident'>RefCell</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
|
||
|
||
<span class='kw'>let</span> <span class='ident'>borrowed_five</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>();
|
||
<span class='kw'>let</span> <span class='ident'>borrowed_five2</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>();</pre>
|
||
|
||
<p>An example of panic:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<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'>thread</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>result</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'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
|
||
<span class='kw'>let</span> <span class='ident'>m</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow_mut</span>();
|
||
|
||
<span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>(); <span class='comment'>// this causes a panic</span>
|
||
}).<span class='ident'>join</span>();
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>result</span>.<span class='ident'>is_err</span>());</pre>
|
||
</div><h4 id='method.borrow_mut' class='method'><code>fn <a href='#method.borrow_mut' class='fnname'>borrow_mut</a>(&self) -> <a class='struct' href='../../../bitflags/__core/cell/struct.RefMut.html' title='bitflags::__core::cell::RefMut'>RefMut</a><T></code></h4>
|
||
<div class='docblock'><p>Mutably borrows the wrapped value.</p>
|
||
|
||
<p>The borrow lasts until the returned <code>RefMut</code> exits scope. The value
|
||
cannot be borrowed while this borrow is active.</p>
|
||
|
||
<h1 id='panics-1' class='section-header'><a href='#panics-1'>Panics</a></h1>
|
||
<p>Panics if the value is currently borrowed.</p>
|
||
|
||
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cell</span>::<span class='ident'>RefCell</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
|
||
|
||
<span class='op'>*</span><span class='ident'>c</span>.<span class='ident'>borrow_mut</span>() <span class='op'>=</span> <span class='number'>7</span>;
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>c</span>.<span class='ident'>borrow</span>(), <span class='number'>7</span>);</pre>
|
||
|
||
<p>An example of panic:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<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'>thread</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>result</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'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
|
||
<span class='kw'>let</span> <span class='ident'>m</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>();
|
||
|
||
<span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow_mut</span>(); <span class='comment'>// this causes a panic</span>
|
||
}).<span class='ident'>join</span>();
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>result</span>.<span class='ident'>is_err</span>());</pre>
|
||
</div><h4 id='method.as_unsafe_cell' class='method'><code>unsafe fn <a href='#method.as_unsafe_cell' class='fnname'>as_unsafe_cell</a>(&self) -> &<a class='struct' href='../../../bitflags/__core/cell/struct.UnsafeCell.html' title='bitflags::__core::cell::UnsafeCell'>UnsafeCell</a><T></code></h4>
|
||
<div class='stability'><em class='stab unstable'>Unstable (<code>as_unsafe_cell</code>)</em></div><div class='docblock'><p>Returns a reference to the underlying <code>UnsafeCell</code>.</p>
|
||
|
||
<p>This can be used to circumvent <code>RefCell</code>'s safety checks.</p>
|
||
|
||
<p>This function is <code>unsafe</code> because <code>UnsafeCell</code>'s field is public.</p>
|
||
</div></div><h3 class='impl'><code>impl<T> <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>const fn <a href='#method.new' class='fnname'>new</a>(value: T) -> <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T></code></h4>
|
||
<div class='docblock'><p>Creates a new <code>RefCell</code> containing <code>value</code>.</p>
|
||
|
||
<h1 id='examples-2' class='section-header'><a href='#examples-2'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cell</span>::<span class='ident'>RefCell</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);</pre>
|
||
</div><h4 id='method.into_inner' class='method'><code>fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> T</code></h4>
|
||
<div class='docblock'><p>Consumes the <code>RefCell</code>, returning the wrapped value.</p>
|
||
|
||
<h1 id='examples-3' class='section-header'><a href='#examples-3'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cell</span>::<span class='ident'>RefCell</span>;
|
||
|
||
<span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>RefCell</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
|
||
|
||
<span class='kw'>let</span> <span class='ident'>five</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>into_inner</span>();</pre>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='../../../bitflags/__core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class='struct' href='../../../bitflags/__core/fmt/struct.Formatter.html' title='bitflags::__core::fmt::Formatter'>Formatter</a>) -> <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.tuple.html'>()</a>, <a class='struct' href='../../../bitflags/__core/fmt/struct.Error.html' title='bitflags::__core::fmt::Error'>Error</a>></code></h4>
|
||
</div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code><span class="since">1.2.0</span></h3><div class='impl-items'></div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialEq.html' title='bitflags::__core::cmp::PartialEq'>PartialEq</a><<a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T>> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialEq.html' title='bitflags::__core::cmp::PartialEq'>PartialEq</a><T> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
|
||
<h4 id='method.ne' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &Rhs) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
|
||
</div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a></span></code></h3><div class='impl-items'><h4 id='method.default' class='method'><code>fn <a href='../../../bitflags/__core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T></code></h4>
|
||
</div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T></code></h4>
|
||
<h4 id='method.clone_from' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code></h4>
|
||
</div><h3 class='impl'><code>impl<T> !<a class='trait' href='../../../bitflags/__core/marker/trait.Sync.html' title='bitflags::__core::marker::Sync'>Sync</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl<T> <a class='trait' href='../../../bitflags/__core/marker/trait.Send.html' title='bitflags::__core::marker::Send'>Send</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.RefCell.html' title='bitflags::__core::cell::RefCell'>RefCell</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Send.html' title='bitflags::__core::marker::Send'>Send</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h3><div class='impl-items'></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>?</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">
|
||
<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 = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |