196 lines
No EOL
18 KiB
HTML
196 lines
No EOL
18 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 `AsRef` trait in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, AsRef">
|
||
|
||
<title>bitflags::__core::convert::AsRef - 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'>convert</a></p><script>window.sidebarCurrent = {name: 'AsRef', ty: 'trait', 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 trait">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>convert</a>::<wbr><a class='trait' href=''>AsRef</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-22585' class='srclink' href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html?gotosrc=22585' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait AsRef<T> <span class='where'>where T: ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span> {
|
||
fn <a href='#tymethod.as_ref' class='fnname'>as_ref</a>(&self) -> &T;
|
||
}</pre><div class='docblock'><p>A cheap, reference-to-reference conversion.</p>
|
||
|
||
<p><code>AsRef</code> is very similar to, but different than, <code>Borrow</code>. See
|
||
<a href="../../book/borrow-and-asref.html">the book</a> for more.</p>
|
||
|
||
<p><strong>Note: this trait must not fail</strong>. If the conversion can fail, use a dedicated method which
|
||
returns an <code>Option<T></code> or a <code>Result<T, E></code>.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<p>Both <code>String</code> and <code>&str</code> implement <code>AsRef<str></code>:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>fn</span> <span class='ident'>is_hello</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>AsRef</span><span class='op'><</span><span class='ident'>str</span><span class='op'>>></span>(<span class='ident'>s</span>: <span class='ident'>T</span>) {
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"hello"</span>, <span class='ident'>s</span>.<span class='ident'>as_ref</span>());
|
||
}
|
||
|
||
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='string'>"hello"</span>;
|
||
<span class='ident'>is_hello</span>(<span class='ident'>s</span>);
|
||
|
||
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='string'>"hello"</span>.<span class='ident'>to_string</span>();
|
||
<span class='ident'>is_hello</span>(<span class='ident'>s</span>);</pre>
|
||
|
||
<h1 id='generic-impls' class='section-header'><a href='#generic-impls'>Generic Impls</a></h1>
|
||
<ul>
|
||
<li><code>AsRef</code> auto-dereference if the inner type is a reference or a mutable
|
||
reference (eg: <code>foo.as_ref()</code> will work the same if <code>foo</code> has type <code>&mut Foo</code> or <code>&&mut Foo</code>)</li>
|
||
</ul>
|
||
</div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.as_ref' class='method stab '><code>fn <a href='#tymethod.as_ref' class='fnname'>as_ref</a>(&self) -> &T</code></h3><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 32]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 31]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 30]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 29]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 28]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 27]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 26]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 25]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 24]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 23]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 22]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 21]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 20]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 19]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 18]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 17]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 16]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 15]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 14]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 13]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 12]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 11]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 10]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 9]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 8]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 7]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 6]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 5]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 4]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 3]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 2]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 1]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.array.html'>; 0]</a></code></li>
|
||
<li><code>impl AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.slice.html'>[</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.slice.html'>]</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='struct' href='../../../bitflags/__core/boxed/struct.Box.html' title='bitflags::__core::boxed::Box'>Box</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></li>
|
||
<li><code>impl<T> AsRef for <a class='struct' href='../../../bitflags/__core/vec/struct.Vec.html' title='bitflags::__core::vec::Vec'>Vec</a><T></code></li>
|
||
<li><code>impl<T> AsRef for <a class='struct' href='../../../bitflags/__core/vec/struct.Vec.html' title='bitflags::__core::vec::Vec'>Vec</a><T></code></li>
|
||
<li><code>impl AsRef for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl AsRef for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a></code></li>
|
||
<li><code>impl AsRef for <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.str.html'>str</a></code></li>
|
||
<li><code>impl<T> AsRef for <a class='struct' href='../../../bitflags/__core/sync/struct.Arc.html' title='bitflags::__core::sync::Arc'>Arc</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></li>
|
||
<li><code>impl<T> AsRef for <a class='struct' href='../../../bitflags/__core/rc/struct.Rc.html' title='bitflags::__core::rc::Rc'>Rc</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></li>
|
||
<li><code>impl<'a, T> AsRef for <a class='enum' href='../../../bitflags/__core/borrow/enum.Cow.html' title='bitflags::__core::borrow::Cow'>Cow</a><'a, T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/borrow/trait.ToOwned.html' title='bitflags::__core::borrow::ToOwned'>ToOwned</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../../implementors/core/convert/trait.AsRef.js">
|
||
</script></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> |