19 lines
4.1 KiB
HTML
19 lines
4.1 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="Pins a variable of type `T` on the stack and rebinds it as `Pin<&mut T>`."><title>pin in futures_lite - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="futures_lite" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../futures_lite/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../futures_lite/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt="logo"></a><h2><a href="../futures_lite/index.html">futures_<wbr>lite</a><span class="version">2.3.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">futures_lite</a></span><h1>Macro <span class="macro">pin</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/futures_lite/lib.rs.html#126-136">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! pin {
|
|
($($x:ident),* $(,)?) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Pins a variable of type <code>T</code> on the stack and rebinds it as <code>Pin<&mut T></code>.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures_lite::{future, pin};
|
|
<span class="kw">use </span>std::fmt::Debug;
|
|
<span class="kw">use </span>std::future::Future;
|
|
<span class="kw">use </span>std::pin::Pin;
|
|
<span class="kw">use </span>std::time::Instant;
|
|
|
|
<span class="comment">// Inspects each invocation of `Future::poll()`.
|
|
</span><span class="kw">async fn </span>inspect<T: Debug>(f: <span class="kw">impl </span>Future<Output = T>) -> T {
|
|
<span class="macro">pin!</span>(f);
|
|
future::poll_fn(|cx| <span class="macro">dbg!</span>(f.as_mut().poll(cx))).<span class="kw">await
|
|
</span>}
|
|
|
|
<span class="kw">let </span>f = <span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">2 </span>};
|
|
inspect(f).<span class="kw">await</span>;</code></pre></div>
|
|
</div></details></section></div></main></body></html> |