danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oxipng/doc/bitflags/__core/cell/struct.Ref.html
Joshua Holmer ea484a8978 Version 0.4.0
2016-04-08 13:52:15 -04:00

167 lines
No EOL
14 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 `Ref` struct in crate `bitflags`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Ref">
<title>bitflags::__core::cell::Ref - 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: 'Ref', 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=''>Ref</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 id='src-28273' class='srclink' href='https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html?gotosrc=28273' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Ref&lt;'b, T&gt; <span class='where'>where T: 'b + ?<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>Wraps a borrowed reference to a value in a <code>RefCell</code> box.
A wrapper type for an immutably borrowed value from a <code>RefCell&lt;T&gt;</code>.</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&lt;'b, T&gt; <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt; <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.clone' class='method'><code>fn <a href='#method.clone' class='fnname'>clone</a>(orig: &amp;<a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt;</code></h4>
<div class='stability'><em class='stab unstable'>Unstable (<code>cell_extras</code>)<p>: likely to be moved to a method, pending language changes</p>
</em></div><div class='docblock'><p>Copies a <code>Ref</code>.</p>
<p>The <code>RefCell</code> is already immutably borrowed, so this cannot fail.</p>
<p>This is an associated function that needs to be used as
<code>Ref::clone(...)</code>. A <code>Clone</code> implementation or a method would interfere
with the widespread use of <code>r.borrow().clone()</code> to clone the contents of
a <code>RefCell</code>.</p>
</div><h4 id='method.map' class='method'><span class="since">1.8.0</span><code>fn <a href='#method.map' class='fnname'>map</a>&lt;U, F&gt;(orig: <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt;, f: F) -&gt; <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, U&gt; <span class='where'>where F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(&amp;T) -&gt; &amp;U, U: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h4>
<div class='docblock'><p>Make a new <code>Ref</code> for a component of the borrowed data.</p>
<p>The <code>RefCell</code> is already immutably borrowed, so this cannot fail.</p>
<p>This is an associated function that needs to be used as <code>Ref::map(...)</code>.
A method would interfere with methods of the same name on the contents
of a <code>RefCell</code> used through <code>Deref</code>.</p>
<h1 id='example' class='section-header'><a href='#example'>Example</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='ident'>Ref</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='string'>&#39;b&#39;</span>));
<span class='kw'>let</span> <span class='ident'>b1</span>: <span class='ident'>Ref</span><span class='op'>&lt;</span>(<span class='ident'>u32</span>, <span class='ident'>char</span>)<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>();
<span class='kw'>let</span> <span class='ident'>b2</span>: <span class='ident'>Ref</span><span class='op'>&lt;</span><span class='ident'>u32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>Ref</span>::<span class='ident'>map</span>(<span class='ident'>b1</span>, <span class='op'>|</span><span class='ident'>t</span><span class='op'>|</span> <span class='kw-2'>&amp;</span><span class='ident'>t</span>.<span class='number'>0</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>b2</span>, <span class='number'>5</span>)</pre>
</div><h4 id='method.filter_map' class='method'><code>fn <a href='#method.filter_map' class='fnname'>filter_map</a>&lt;U, F&gt;(orig: <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt;, f: F) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;<a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, U&gt;&gt; <span class='where'>where U: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a>, F: <a class='trait' href='../../../bitflags/__core/ops/trait.FnOnce.html' title='bitflags::__core::ops::FnOnce'>FnOnce</a>(&amp;T) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;&amp;U&gt;</span></code></h4>
<div class='stability'><em class='stab unstable deprecated'>Deprecated since 1.8.0<p>: can be built on <code>Ref::map</code>: <a href="https://crates.io/crates/ref_filter_map">https://crates.io/crates/ref_filter_map</a></p>
</em></div><div class='docblock'><p>Make a new <code>Ref</code> for an optional component of the borrowed data, e.g. an
enum variant.</p>
<p>The <code>RefCell</code> is already immutably borrowed, so this cannot fail.</p>
<p>This is an associated function that needs to be used as
<code>Ref::filter_map(...)</code>. A method would interfere with methods of the
same name on the contents of a <code>RefCell</code> used through <code>Deref</code>.</p>
<h1 id='example-1' class='section-header'><a href='#example-1'>Example</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='ident'>Ref</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='prelude-val'>Ok</span>(<span class='number'>5</span>));
<span class='kw'>let</span> <span class='ident'>b1</span>: <span class='ident'>Ref</span><span class='op'>&lt;</span><span class='prelude-ty'>Result</span><span class='op'>&lt;</span><span class='ident'>u32</span>, ()<span class='op'>&gt;&gt;</span> <span class='op'>=</span> <span class='ident'>c</span>.<span class='ident'>borrow</span>();
<span class='kw'>let</span> <span class='ident'>b2</span>: <span class='ident'>Ref</span><span class='op'>&lt;</span><span class='ident'>u32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>Ref</span>::<span class='ident'>filter_map</span>(<span class='ident'>b1</span>, <span class='op'>|</span><span class='ident'>o</span><span class='op'>|</span> <span class='ident'>o</span>.<span class='ident'>as_ref</span>().<span class='ident'>ok</span>()).<span class='ident'>unwrap</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='op'>*</span><span class='ident'>b2</span>, <span class='number'>5</span>)</pre>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl&lt;'b, T&gt; <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.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt; <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>(&amp;self, f: &amp;mut <a class='struct' href='../../../bitflags/__core/fmt/struct.Formatter.html' title='bitflags::__core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a>&lt;<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>&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;'b, T, U&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.CoerceUnsized.html' title='bitflags::__core::ops::CoerceUnsized'>CoerceUnsized</a>&lt;<a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, U&gt;&gt; for <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt; <span class='where'>where U: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a>, T: <a class='trait' href='../../../bitflags/__core/marker/trait.Unsize.html' title='bitflags::__core::marker::Unsize'>Unsize</a>&lt;U&gt; + ?<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&lt;'b, T&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.Deref.html' title='bitflags::__core::ops::Deref'>Deref</a> for <a class='struct' href='../../../bitflags/__core/cell/struct.Ref.html' title='bitflags::__core::cell::Ref'>Ref</a>&lt;'b, T&gt; <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='associatedtype.Target' class='type'><code>type <a href='../../../bitflags/__core/ops/trait.Deref.html#associatedtype.Target' class='type'>Target</a> = T</code></h4>
<h4 id='method.deref' class='method'><code>fn <a href='../../../bitflags/__core/ops/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;T</code></h4>
</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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>
Reference in a new issue View git blame Copy permalink