165 lines
No EOL
9.6 KiB
HTML
165 lines
No EOL
9.6 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 `__Deref` trait in crate `lazy_static`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, __Deref">
|
||
|
||
<title>lazy_static::__Deref - 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'>lazy_static</a></p><script>window.sidebarCurrent = {name: '__Deref', 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'>lazy_static</a>::<wbr><a class='trait' href=''>__Deref</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><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-22396' class='srclink' href='https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html?gotosrc=22396' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait __Deref {
|
||
type <a href='#associatedtype.Target' class='type'>Target</a>: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>;
|
||
fn <a href='#tymethod.deref' class='fnname'>deref</a>(&self) -> &Self::<a class='trait' href='../lazy_static/trait.__Deref.html' title='lazy_static::__Deref'>Target</a>;
|
||
}</pre><div class='docblock'><p>The <code>Deref</code> trait is used to specify the functionality of dereferencing
|
||
operations, like <code>*v</code>.</p>
|
||
|
||
<p><code>Deref</code> also enables <a href="../../book/deref-coercions.html">'<code>Deref</code> coercions'</a>.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<p>A struct with a single field which is accessible via dereferencing the
|
||
struct.</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Deref</span>;
|
||
|
||
<span class='kw'>struct</span> <span class='ident'>DerefExample</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> {
|
||
<span class='ident'>value</span>: <span class='ident'>T</span>
|
||
}
|
||
|
||
<span class='kw'>impl</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>DerefExample</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> {
|
||
<span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>T</span>;
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>T</span> {
|
||
<span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>value</span>
|
||
}
|
||
}
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>main</span>() {
|
||
<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='ident'>DerefExample</span> { <span class='ident'>value</span>: <span class='string'>'a'</span> };
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>'a'</span>, <span class='op'>*</span><span class='ident'>x</span>);
|
||
}</pre>
|
||
</div>
|
||
<h2 id='associated-types'>Associated Types</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Target' class='method stab '><code>type <a href='#associatedtype.Target' class='type'>Target</a>: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></code></h3><div class='docblock'><p>The resulting type after dereferencing</p>
|
||
</div></div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.deref' class='method stab '><code>fn <a href='#tymethod.deref' class='fnname'>deref</a>(&self) -> &Self::<a class='trait' href='../lazy_static/trait.__Deref.html' title='lazy_static::__Deref'>Target</a></code></h3><div class='docblock'><p>The method called to dereference a value</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl<T> Deref for <a class='struct' href='https://doc.rust-lang.org/nightly/core/nonzero/struct.NonZero.html' title='core::nonzero::NonZero'>NonZero</a><T> <span class='where'>where T: <a class='trait' href='https://doc.rust-lang.org/nightly/core/nonzero/trait.Zeroable.html' title='core::nonzero::Zeroable'>Zeroable</a></span></code></li>
|
||
<li><code>impl<T> Deref for <a class='struct' href='https://doc.rust-lang.org/nightly/core/ptr/struct.Unique.html' title='core::ptr::Unique'>Unique</a><T> <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
<li><code>impl<T> Deref for <a class='struct' href='https://doc.rust-lang.org/nightly/core/ptr/struct.Shared.html' title='core::ptr::Shared'>Shared</a><T> <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
<li><code>impl<'a, T> Deref for &'a T <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
<li><code>impl<'a, T> Deref for &'a mut T <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
<li><code>impl<'b, T> Deref for <a class='struct' href='https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html' title='core::cell::Ref'>Ref</a><'b, T> <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
<li><code>impl<'b, T> Deref for <a class='struct' href='https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html' title='core::cell::RefMut'>RefMut</a><'b, T> <span class='where'>where T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../implementors/core/ops/trait.__Deref.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>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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 = "lazy_static";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../jquery.js"></script>
|
||
<script src="../main.js"></script>
|
||
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |