<!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 `PinMut` struct in crate `core`."><meta name="keywords" content="rust, rustlang, rust-lang, PinMut"><title>core::mem::PinMut - 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="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></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><a href='../../core/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Struct PinMut</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.new_unchecked">new_unchecked</a><a href="#method.reborrow">reborrow</a><a href="#method.get_mut">get_mut</a><a href="#method.map">map</a><a href="#method.set">set</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Deref">Deref</a><a href="#impl-DerefMut">DerefMut</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a><a href="#impl-Pointer">Pointer</a><a href="#impl-CoerceUnsized%3CPinMut%3C%27a%2C%20U%3E%3E">CoerceUnsized<PinMut<'a, U>></a><a href="#impl-Unpin">Unpin</a><a href="#impl-Future">Future</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>core</a>::<wbr><a href='index.html'>mem</a></p><script>window.sidebarCurrent = {name: 'PinMut', 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"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>core</a>::<wbr><a href='index.html'>mem</a>::<wbr><a class="struct" href=''>PinMut</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></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 class='srclink' href='../../src/core/mem.rs.html#1110-1112' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct PinMut<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> { /* fields omitted */ }</pre></div><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>A pinned reference.</p>
<p>A pinned reference is a lot like a mutable reference, except that it is not
safe to move a value out of a pinned reference unless the type of that
value implements the <code>Unpin</code> trait.</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'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1115-1122' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(reference: &'a mut T) -> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1119-1121' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Construct a new <code>PinMut</code> around a reference to some data of a type that
implements <code>Unpin</code>.</p>
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1126-1180' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new_unchecked' class="method"><span id='new_unchecked.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.new_unchecked' class='fnname'>new_unchecked</a>(reference: &'a mut T) -> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1134-1136' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Construct a new <code>PinMut</code> around a reference to some data of a type that
may or may not implement <code>Unpin</code>.</p>
<p>This constructor is unsafe because we do not know what will happen with
that data after the reference ends. If you cannot guarantee that the
data will never move again, calling this constructor is invalid.</p>
</div><h4 id='method.reborrow' class="method"><span id='reborrow.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.reborrow' class='fnname'>reborrow</a><'b>(&'b mut self) -> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'b, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1143-1145' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Reborrow a <code>PinMut</code> for a shorter lifetime.</p>
<p>For example, <code>PinMut::get_mut(x.reborrow())</code> (unsafely) returns a
short-lived mutable reference reborrowing from <code>x</code>.</p>
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.get_mut' class='fnname'>get_mut</a>(this: <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T>) -> &'a mut T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1153-1155' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Get a mutable reference to the data inside of this <code>PinMut</code>.</p>
<p>This function is unsafe. You must guarantee that you will never move
the data out of the mutable reference you receive when you call this
function.</p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.map' class='fnname'>map</a><U, F>(this: <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T>, f: F) -> <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, U> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(&mut T) -> &mut U, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1167-1171' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Construct a new pin by mapping the interior value.</p>
<p>For example, if you wanted to get a <code>PinMut</code> of a field of something, you
could use this to get access to that field in one line of code.</p>
<p>This function is unsafe. You must guarantee that the data you return
will not move so long as the argument value does not move (for example,
because it is one of the fields of that value), and also that you do
not move out of the argument you receive to the interior function.</p>
</div><h4 id='method.set' class="method"><span id='set.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set' class='fnname'>set</a>(this: <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T>, value: T) <span class="where fmt-newline">where<br> T: <a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1175-1179' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>pin </code><a href="https://github.com/rust-lang/rust/issues/49150">#49150</a>)</div></div><div class='docblock'><p>Assign a new value to the memory behind the pinned reference.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Deref' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/ops/trait.Deref.html" title="trait core::ops::Deref">Deref</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-Deref' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1183-1189' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='../../core/ops/trait.Deref.html#associatedtype.Target' class="type">Target</a> = T</code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/ops/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&self) -> &T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1186-1188' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Dereferences the value.</p>
</div></div><h3 id='impl-DerefMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="../../core/ops/trait.DerefMut.html" title="trait core::ops::DerefMut">DerefMut</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-DerefMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1192-1196' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.deref_mut' class="method"><span id='deref_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/ops/trait.DerefMut.html#tymethod.deref_mut' class='fnname'>deref_mut</a>(&mut self) -> &mut T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1193-1195' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably dereferences the value.</p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: <a class="trait" href="../../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1199-1203' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="../../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="../../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1200-1202' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="../../core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: <a class="trait" href="../../core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-Display' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1206-1210' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="../../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="../../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1207-1209' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="../../core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Pointer' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/fmt/trait.Pointer.html" title="trait core::fmt::Pointer">Pointer</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-Pointer' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1213-1217' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt-2' class="method"><span id='fmt.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/fmt/trait.Pointer.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="../../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="../../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1214-1216' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 id='impl-CoerceUnsized%3CPinMut%3C%27a%2C%20U%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/marker/trait.Unsize.html" title="trait core::marker::Unsize">Unsize</a><U>, U: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/ops/trait.CoerceUnsized.html" title="trait core::ops::CoerceUnsized">CoerceUnsized</a><<a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, U>> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-CoerceUnsized%3CPinMut%3C%27a%2C%20U%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1220' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T></code><a href='#impl-Unpin' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/mem.rs.html#1223' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Future' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, F: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/future/trait.Future.html" title="trait core::future::Future">Future</a>> <a class="trait" href="../../core/future/trait.Future.html" title="trait core::future::Future">Future</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, F></code><a href='#impl-Future' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/future.rs.html#104-110' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Output' class="type"><span id='Output.t' class='invisible'><code>type <a href='../../core/future/trait.Future.html#associatedtype.Output' class="type">Output</a> = F::<a class="type" href="../../core/future/trait.Future.html#associatedtype.Output" title="type core::future::Future::Output">Output</a></code></span></h4>
<div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>The result of the <code>Future</code>.</p>
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../core/future/trait.Future.html#tymethod.poll' class='fnname'>poll</a>(self: <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><Self>, cx: &mut <a class="struct" href="../../core/task/struct.Context.html" title="struct core::task::Context">Context</a>) -> <a class="enum" href="../../core/task/enum.Poll.html" title="enum core::task::Poll">Poll</a><Self::<a class="type" href="../../core/future/trait.Future.html#associatedtype.Output" title="type core::future::Future::Output">Output</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/core/future.rs.html#107-109' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. <a href="../../core/future/trait.Future.html#tymethod.poll">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
</h2>
<div id='synthetic-implementations-list'>
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="../../core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../core/mem/struct.PinMut.html" title="struct core::mem::PinMut">PinMut</a><'a, T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "core";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
