rust
/
rust-course
mirror of https://github.com/sunface/rust-course
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '12108c0325'
${ noResults }
rust-course/advance/async/pin-unpin.html

664 lines
82 KiB
Raw Normal View History Unescape

deploy
1 month ago
<!DOCTYPE HTML>
<html lang="zh-CN" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>定海神针 Pin 和 Unpin - Rust语言圣经(Rust Course)</title>
<!-- Custom HTML head -->
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../../favicon.svg">
<link rel="shortcut icon" href="../../favicon.png">
<link rel="stylesheet" href="../../css/variables.css">
<link rel="stylesheet" href="../../css/general.css">
<link rel="stylesheet" href="../../css/chrome.css">
<link rel="stylesheet" href="../../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../../highlight.css">
<link rel="stylesheet" href="../../tomorrow-night.css">
<link rel="stylesheet" href="../../ayu-highlight.css">
<!-- Custom theme stylesheets -->
<link rel="stylesheet" href="../../theme/style.css">
</head>
<body class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "../../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item affix "><a href="../../about-book.html">关于本书</a></li><li class="chapter-item affix "><a href="../../into-rust.html">进入 Rust 编程世界</a></li><li class="chapter-item affix "><a href="../../first-try/sth-you-should-not-do.html">避免从入门到放弃</a></li><li class="chapter-item affix "><a href="../../community.html">社区和锈书</a></li><li class="spacer"></li><li class="chapter-item affix "><a href="../../some-thoughts.html">Xobserve: 一切皆可观测</a></li><li class="chapter-item affix "><a href="../../beat-ai.html">BeatAI: 工程师 AI 入门圣经</a></li><li class="chapter-item affix "><li class="part-title">Rust 语言基础学习</li><li class="spacer"></li><li class="chapter-item "><a href="../../first-try/intro.html"><strong aria-hidden="true">1.</strong> 寻找牛刀，以便小试</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../first-try/installation.html"><strong aria-hidden="true">1.1.</strong> 安装 Rust 环境</a></li><li class="chapter-item "><a href="../../first-try/editor.html"><strong aria-hidden="true">1.2.</strong> 墙推 VSCode!</a></li><li class="chapter-item "><a href="../../first-try/cargo.html"><strong aria-hidden="true">1.3.</strong> 认识 Cargo</a></li><li class="chapter-item "><a href="../../first-try/hello-world.html"><strong aria-hidden="true">1.4.</strong> 不仅仅是 Hello world</a></li><li class="chapter-item "><a href="../../first-try/slowly-downloading.html"><strong aria-hidden="true">1.5.</strong> 下载依赖太慢了？</a></li></ol></li><li class="chapter-item "><a href="../../basic/intro.html"><strong aria-hidden="true">2.</strong> Rust 基础入门</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/variable.html"><strong aria-hidden="true">2.1.</strong> 变量绑定与解构</a></li><li class="chapter-item "><a href="../../basic/base-type/index.html"><strong aria-hidden="true">2.2.</strong> 基本类型</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/base-type/numbers.html"><strong aria-hidden="true">2.2.1.</strong> 数值类型</a></li><li class="chapter-item "><a href="../../basic/base-type/char-bool.html"><strong aria-hidden="true">2.2.2.</strong> 字符、布尔、单元类型</a></li><li class="chapter-item "><a href="../../basic/base-type/statement-expression.html"><strong aria-hidden="true">2.2.3.</strong> 语句与表达式</a></li><li class="chapter-item "><a href="../../basic/base-type/function.html"><strong aria-hidden="true">2.2.4.</strong> 函数</a></li></ol></li><li class="chapter-item "><a href="../../basic/ownership/index.html"><strong aria-hidden="true">2.3.</strong> 所有权和借用</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/ownership/ownership.html"><strong aria-hidden="true">2.3.1.</strong> 所有权</a></li><li class="chapter-item "><a href="../../basic/ownership/borrowing.html"><strong aria-hidden="true">2.3.2.</strong> 引用与借用</a></li></ol></li><li class="chapter-item "><a href="../../basic/compound-type/intro.html"><strong aria-hidden="true">2.4.</strong> 复合类型</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../basic/compound-type/string-slice.html"><strong aria-hidden="true">2.4.1.</strong> 字符串与切片</a></li><li class="chapter-item "><a href="../../basic/compound-type/tuple.html"><strong aria-hidden="true">2.4.2.</strong> 元组</a></li><li class="chapter-item "><a href="../../basic/compound-type/struct.html"><strong aria-hidden="true">2.4.3.</strong> 结构体</a></li><li class="chapter-item "><a href="../../basic/compound-type/enum.html"><strong aria-hidden="true">2.4.4.</strong> 枚举</a></li><li class="chapter-item "><a href="../../basic/compound-type/array.html"><strong aria-hidden="true">2.4.5.</strong> 数组</a></l
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Rust语言圣经(Rust Course)</h1>
<div class="right-buttons">
<a href="../../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/sunface/rust-course" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/sunface/rust-course/edit/main/src/advance/async/pin-unpin.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<!-- Page table of contents -->
<div class="sidetoc"><nav class="pagetoc"></nav></div>
<main>
<h1 id="定海神针-pin-和-unpin"><a class="header" href="#定海神针-pin-和-unpin">定海神针 Pin 和 Unpin</a></h1>
<p>在 Rust 异步编程中，有一个定海神针般的存在，它就是 <code>Pin</code>，作用说简单也简单，说复杂也非常复杂，当初刚出来时就连一些 Rust 大佬都一头雾水，何况瑟瑟发抖的我。好在今非昔比，目前网上的资料已经很全，而我就借花献佛，给大家好好讲讲这个 <code>Pin</code>。</p>
<p>在 Rust 中，所有的类型可以分为两类:</p>
<ul>
<li><strong>类型的值可以在内存中安全地被移动</strong>，例如数值、字符串、布尔值、结构体、枚举，总之你能想到的几乎所有类型都可以落入到此范畴内</li>
<li><strong>自引用类型</strong>，大魔王来了，大家快跑，在之前章节我们已经见识过它的厉害</li>
</ul>
<p>下面就是一个自引用类型</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>struct SelfRef {
value: String,
pointer_to_value: *mut String,
}
<span class="boring">}</span></code></pre></pre>
<p>在上面的结构体中，<code>pointer_to_value</code> 是一个裸指针，指向第一个字段 <code>value</code> 持有的字符串 <code>String</code> 。很简单对吧？现在考虑一个情况， 若 <code>value</code> 被移动了怎么办？</p>
<p>此时一个致命的问题就出现了：<code>value</code> 的内存地址变了，而 <code>pointer_to_value</code> 依然指向 <code>value</code> 之前的地址，一个重大 bug 就出现了！</p>
<p>灾难发生，英雄在哪？只见 <code>Pin</code> 闪亮登场，它可以防止一个类型在内存中被移动。再来回忆下之前在 <code>Future</code> 章节中，我们提到过在 <code>poll</code> 方法的签名中有一个 <code>self: Pin&lt;&amp;mut Self&gt;</code> ，那么为何要在这里使用 <code>Pin</code> 呢？</p>
<h2 id="为何需要-pin"><a class="header" href="#为何需要-pin">为何需要 Pin</a></h2>
<p>其实 <code>Pin</code> 还有一个小伙伴 <code>UnPin</code> ，与前者相反，后者表示类型可以在内存中安全地移动。在深入之前，我们先来回忆下 <code>async/.await</code> 是如何工作的:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>let fut_one = /* ... */; // Future 1
let fut_two = /* ... */; // Future 2
async move {
fut_one.await;
fut_two.await;
}
<span class="boring">}</span></code></pre></pre>
<p>在底层，<code>async</code> 会创建一个实现了 <code>Future</code> 的匿名类型，并提供了一个 <code>poll</code> 方法：</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// `async { ... }`语句块创建的 `Future` 类型
struct AsyncFuture {
fut_one: FutOne,
fut_two: FutTwo,
state: State,
}
// `async` 语句块可能处于的状态
enum State {
AwaitingFutOne,
AwaitingFutTwo,
Done,
}
impl Future for AsyncFuture {
type Output = ();
fn poll(mut self: Pin&lt;&amp;mut Self&gt;, cx: &amp;mut Context&lt;'_&gt;) -&gt; Poll&lt;()&gt; {
loop {
match self.state {
State::AwaitingFutOne =&gt; match self.fut_one.poll(..) {
Poll::Ready(()) =&gt; self.state = State::AwaitingFutTwo,
Poll::Pending =&gt; return Poll::Pending,
}
State::AwaitingFutTwo =&gt; match self.fut_two.poll(..) {
Poll::Ready(()) =&gt; self.state = State::Done,
Poll::Pending =&gt; return Poll::Pending,
}
State::Done =&gt; return Poll::Ready(()),
}
}
}
}
<span class="boring">}</span></code></pre></pre>
<p>当 <code>poll</code> 第一次被调用时，它会去查询 <code>fut_one</code> 的状态，若 <code>fut_one</code> 无法完成，则 <code>poll</code> 方法会返回。未来对 <code>poll</code> 的调用将从上一次调用结束的地方开始。该过程会一直持续，直到 <code>Future</code> 完成为止。</p>
<p>然而，如果我们的 <code>async</code> 语句块中使用了引用类型，会发生什么？例如下面例子：</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>async {
let mut x = [0; 128];
let read_into_buf_fut = read_into_buf(&amp;mut x);
read_into_buf_fut.await;
println!(&quot;{:?}&quot;, x);
}
<span class="boring">}</span></code></pre></pre>
<p>这段代码会编译成下面的形式：</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>struct ReadIntoBuf&lt;'a&gt; {
buf: &amp;'a mut [u8], // 指向下面的`x`字段
}
struct AsyncFuture {
x: [u8; 128],
read_into_buf_fut: ReadIntoBuf&lt;'what_lifetime?&gt;,
}
<span class="boring">}</span></code></pre></pre>
<p>这里，<code>ReadIntoBuf</code> 拥有一个引用字段，指向了结构体的另一个字段 <code>x</code> ，一旦 <code>AsyncFuture</code> 被移动，那 <code>x</code> 的地址也将随之变化，此时对 <code>x</code> 的引用就变成了不合法的，也就是 <code>read_into_buf_fut.buf</code> 会变为不合法的。</p>
<p>若能将 <code>Future</code> 在内存中固定到一个位置，就可以避免这种问题的发生，也就可以安全的创建上面这种引用类型。</p>
<h2 id="unpin"><a class="header" href="#unpin">Unpin</a></h2>
<p>事实上，绝大多数类型都不在意是否被移动(开篇提到的第一种类型)，因此它们都<strong>自动实现</strong>了 <code>Unpin</code> 特征。</p>
<p>从名字推测，大家可能以为 <code>Pin</code> 和 <code>Unpin</code> 都是特征吧？实际上，<code>Pin</code> 不按套路出牌，它是一个结构体：</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct Pin&lt;P&gt; {
pointer: P,
}
<span class="boring">}</span></code></pre></pre>
<p>它包裹一个指针，并且能确保该指针指向的数据不会被移动，例如 <code>Pin&lt;&amp;mut T&gt;</code> , <code>Pin&lt;&amp;T&gt;</code> , <code>Pin&lt;Box&lt;T&gt;&gt;</code> ，都能确保 <code>T</code> 不会被移动。</p>
<img alt="" src="https://pic1.zhimg.com/80/v2-de79f3a7a401588d671ecd121916cd90_1440w.png" class="center" />
<p>而 <code>Unpin</code> 才是一个特征，它表明一个类型可以随意被移动，那么问题来了，可以被 <code>Pin</code> 住的值，它有没有实现什么特征呢？ 答案很出乎意料，可以被 <code>Pin</code> 住的值实现的特征是 <code>!Unpin</code> ，大家可能之前没有见过，但是它其实很简单，<code>!</code> 代表没有实现某个特征的意思，<code>!Unpin</code> 说明类型没有实现 <code>Unpin</code> 特征，那自然就可以被 <code>Pin</code> 了。</p>
<p>那是不是意味着类型如果实现了 <code>Unpin</code> 特征，就不能被 <code>Pin</code> 了？其实，还是可以 <code>Pin</code> 的，毕竟它只是一个结构体，你可以随意使用，<strong>但是不再有任何效果而已，该值一样可以被移动</strong>！</p>
<p>例如 <code>Pin&lt;&amp;mut u8&gt;</code> ，显然 <code>u8</code> 实现了 <code>Unpin</code> 特征，它可以在内存中被移动，因此 <code>Pin&lt;&amp;mut u8&gt;</code> 跟 <code>&amp;mut u8</code> 实际上并无区别，一样可以被移动。</p>
<p>因此，一个类型如果不能被移动，它必须实现 <code>!Unpin</code> 特征。如果大家对 <code>Pin</code> 、 <code>Unpin</code> 还是模模糊糊，建议再重复看一遍之前的内容，理解它们对于我们后面要讲到的内容非常重要！</p>
<p>如果将 <code>Unpin</code> 与之前章节学过的 <a href="https://course.rs/advance/concurrency-with-threads/send-sync.html"><code>Send/Sync</code></a> 进行下对比，会发现它们都很像：</p>
<ul>
<li>都是标记特征( marker trait )，该特征未定义任何行为，非常适用于标记</li>
<li>都可以通过<code>!</code>语法去除实现</li>
<li>绝大多数情况都是自动实现, 无需我们的操心</li>
</ul>
<h2 id="深入理解-pin"><a class="header" href="#深入理解-pin">深入理解 Pin</a></h2>
<p>对于上面的问题，我们可以简单的归结为如何在 Rust 中处理自引用类型(果然，只要是难点，都和自引用脱离不了关系)，下面用一个稍微简单点的例子来理解下 <code>Pin</code> :</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>#[derive(Debug)]
struct Test {
a: String,
b: *const String,
}
impl Test {
fn new(txt: &amp;str) -&gt; Self {
Test {
a: String::from(txt),
b: std::ptr::null(),
}
}
fn init(&amp;mut self) {
let self_ref: *const String = &amp;self.a;
self.b = self_ref;
}
fn a(&amp;self) -&gt; &amp;str {
&amp;self.a
}
fn b(&amp;self) -&gt; &amp;String {
assert!(!self.b.is_null(), &quot;Test::b called without Test::init being called first&quot;);
unsafe { &amp;*(self.b) }
}
}
<span class="boring">}</span></code></pre></pre>
<p><code>Test</code> 提供了方法用于获取字段 <code>a</code> 和 <code>b</code> 的值的引用。这里<code>b</code> 是 <code>a</code> 的一个引用，但是我们并没有使用引用类型而是用了裸指针，原因是：Rust 的借用规则不允许我们这样用，因为不符合生命周期的要求。 此时的 <code>Test</code> 就是一个自引用结构体。</p>
<p>如果不移动任何值，那么上面的例子将没有任何问题，例如:</p>
<pre><pre class="playground"><code class="language-rust edition2021">fn main() {
let mut test1 = Test::new(&quot;test1&quot;);
test1.init();
let mut test2 = Test::new(&quot;test2&quot;);
test2.init();
println!(&quot;a: {}, b: {}&quot;, test1.a(), test1.b());
println!(&quot;a: {}, b: {}&quot;, test2.a(), test2.b());
}</code></pre></pre>
<p>输出非常正常：</p>
<pre><code class="language-console">a: test1, b: test1
a: test2, b: test2
</code></pre>
<p>明知山有虎，偏向虎山行，这才是我辈年轻人的风华。既然移动数据会导致指针不合法，那我们就移动下数据试试，将 <code>test1</code> 和 <code>test2</code> 进行下交换：</p>
<pre><pre class="playground"><code class="language-rust edition2021">fn main() {
let mut test1 = Test::new(&quot;test1&quot;);
test1.init();
let mut test2 = Test::new(&quot;test2&quot;);
test2.init();
println!(&quot;a: {}, b: {}&quot;, test1.a(), test1.b());
std::mem::swap(&amp;mut test1, &amp;mut test2);
println!(&quot;a: {}, b: {}&quot;, test2.a(), test2.b());
}</code></pre></pre>
<p>按理来说，这样修改后，输出应该如下:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>a: test1, b: test1
a: test1, b: test1
<span class="boring">}</span></code></pre></pre>
<p>但是实际运行后，却产生了下面的输出:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>a: test1, b: test1
a: test1, b: test2
<span class="boring">}</span></code></pre></pre>
<p>原因是 <code>test2.b</code> 指针依然指向了旧的地址，而该地址对应的值现在在 <code>test1</code> 里，最终会打印出意料之外的值。</p>
<p>如果大家还是将信将疑，那再看看下面的代码：</p>
<pre><pre class="playground"><code class="language-rust edition2021">fn main() {
let mut test1 = Test::new(&quot;test1&quot;);
test1.init();
let mut test2 = Test::new(&quot;test2&quot;);
test2.init();
println!(&quot;a: {}, b: {}&quot;, test1.a(), test1.b());
std::mem::swap(&amp;mut test1, &amp;mut test2);
test1.a = &quot;I've totally changed now!&quot;.to_string();
println!(&quot;a: {}, b: {}&quot;, test2.a(), test2.b());
}</code></pre></pre>
<p>下面的图片也可以帮助更好的理解这个过程：</p>
<img alt="" src="https://pica.zhimg.com/80/v2-eaeb33da283dc1063b862d2307821976_1440w.jpg" class="center" />
<h2 id="pin-在实践中的运用"><a class="header" href="#pin-在实践中的运用">Pin 在实践中的运用</a></h2>
<p>在理解了 <code>Pin</code> 的作用后，我们再来看看它怎么帮我们解决问题。</p>
<h4 id="将值固定到栈上"><a class="header" href="#将值固定到栈上">将值固定到栈上</a></h4>
<p>回到之前的例子，我们可以用 <code>Pin</code> 来解决指针指向的数据被移动的问题:</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>use std::pin::Pin;
use std::marker::PhantomPinned;
#[derive(Debug)]
struct Test {
a: String,
b: *const String,
_marker: PhantomPinned,
}
impl Test {
fn new(txt: &amp;str) -&gt; Self {
Test {
a: String::from(txt),
b: std::ptr::null(),
_marker: PhantomPinned, // 这个标记可以让我们的类型自动实现特征`!Unpin`
}
}
fn init(self: Pin&lt;&amp;mut Self&gt;) {
let self_ptr: *const String = &amp;self.a;
let this = unsafe { self.get_unchecked_mut() };
this.b = self_ptr;
}
fn a(self: Pin&lt;&amp;Self&gt;) -&gt; &amp;str {
&amp;self.get_ref().a
}
fn b(self: Pin&lt;&amp;Self&gt;) -&gt; &amp;String {
assert!(!self.b.is_null(), &quot;Test::b called without Test::init being called first&quot;);
unsafe { &amp;*(self.b) }
}
}
<span class="boring">}</span></code></pre></pre>
<p>上面代码中，我们使用了一个标记类型 <code>PhantomPinned</code> 将自定义结构体 <code>Test</code> 变成了 <code>!Unpin</code> (编译器会自动帮我们实现)，因此该结构体无法再被移动。</p>
<p>一旦类型实现了 <code>!Unpin</code> ，那将它的值固定到栈( <code>stack</code> )上就是不安全的行为，因此在代码中我们使用了 <code>unsafe</code> 语句块来进行处理，你也可以使用 <a href="https://docs.rs/pin-utils/"><code>pin_utils</code></a> 来避免 <code>unsafe</code> 的使用。</p>
<blockquote>
<p>BTW, Rust 中的 unsafe 其实没有那么可怕，虽然听上去很不安全，但是实际上 Rust 依然提供了很多机制来帮我们提升了安全性，因此不必像对待 Go 语言的 <code>unsafe</code> 那样去畏惧于使用 Rust 中的 <code>unsafe</code> ，大致使用原则总结如下：没必要用时，就不要用，当有必要用时，就大胆用，但是尽量控制好边界，让 <code>unsafe</code> 的范围尽可能小</p>
</blockquote>
<p>此时，再去尝试移动被固定的值，就会导致<strong>编译错误</strong>：</p>
<pre><pre class="playground"><code class="language-rust edition2021">pub fn main() {
// 此时的`test1`可以被安全的移动
let mut test1 = Test::new(&quot;test1&quot;);
// 新的`test1`由于使用了`Pin`，因此无法再被移动，这里的声明会将之前的`test1`遮蔽掉(shadow)
let mut test1 = unsafe { Pin::new_unchecked(&amp;mut test1) };
Test::init(test1.as_mut());
let mut test2 = Test::new(&quot;test2&quot;);
let mut test2 = unsafe { Pin::new_unchecked(&amp;mut test2) };
Test::init(test2.as_mut());
println!(&quot;a: {}, b: {}&quot;, Test::a(test1.as_ref()), Test::b(test1.as_ref()));
std::mem::swap(test1.get_mut(), test2.get_mut());
println!(&quot;a: {}, b: {}&quot;, Test::a(test2.as_ref()), Test::b(test2.as_ref()));
}</code></pre></pre>
<p>注意到之前的粗体字了吗？是的，Rust 并不是在运行时做这件事，而是在编译期就完成了，因此没有额外的性能开销！来看看报错:</p>
<pre><code class="language-shell">error[E0277]: `PhantomPinned` cannot be unpinned
--&gt; src/main.rs:47:43
|
47 | std::mem::swap(test1.get_mut(), test2.get_mut());
| ^^^^^^^ within `Test`, the trait `Unpin` is not implemented for `PhantomPinned`
</code></pre>
<blockquote>
<p>需要注意的是固定在栈上非常依赖于你写出的 <code>unsafe</code> 代码的正确性。我们知道 <code>&amp;'a mut T</code> 可以固定的生命周期是 <code>'a</code> ，但是我们却不知道当生命周期 <code>'a</code> 结束后，该指针指向的数据是否会被移走。如果你的 <code>unsafe</code> 代码里这么实现了，那么就会违背 <code>Pin</code> 应该具有的作用！</p>
<p>一个常见的错误就是忘记去<a href="https://course.rs/basic/variable.html#%E5%8F%98%E9%87%8F%E9%81%AE%E8%94%BDshadowing">遮蔽( shadow )</a>初始的变量，因为你可以 <code>drop</code> 掉 <code>Pin</code> ，然后在 <code>&amp;'a mut T</code> 结束后去移动数据:</p>
<pre><pre class="playground"><code class="language-rust edition2021">fn main() {
let mut test1 = Test::new(&quot;test1&quot;);
let mut test1_pin = unsafe { Pin::new_unchecked(&amp;mut test1) };
Test::init(test1_pin.as_mut());
drop(test1_pin);
println!(r#&quot;test1.b points to &quot;test1&quot;: {:?}...&quot;#, test1.b);
let mut test2 = Test::new(&quot;test2&quot;);
mem::swap(&amp;mut test1, &amp;mut test2);
println!(&quot;... and now it points nowhere: {:?}&quot;, test1.b);
}
<span class="boring">use std::pin::Pin;
</span><span class="boring">use std::marker::PhantomPinned;
</span><span class="boring">use std::mem;
</span><span class="boring">
</span><span class="boring">#[derive(Debug)]
</span><span class="boring">struct Test {
</span><span class="boring"> a: String,
</span><span class="boring"> b: *const String,
</span><span class="boring"> _marker: PhantomPinned,
</span><span class="boring">}
</span><span class="boring">
</span><span class="boring">
</span><span class="boring">impl Test {
</span><span class="boring"> fn new(txt: &amp;str) -&gt; Self {
</span><span class="boring"> Test {
</span><span class="boring"> a: String::from(txt),
</span><span class="boring"> b: std::ptr::null(),
</span><span class="boring"> // This makes our type `!Unpin`
</span><span class="boring"> _marker: PhantomPinned,
</span><span class="boring"> }
</span><span class="boring"> }
</span><span class="boring">
</span><span class="boring"> fn init&lt;'a&gt;(self: Pin&lt;&amp;'a mut Self&gt;) {
</span><span class="boring"> let self_ptr: *const String = &amp;self.a;
</span><span class="boring"> let this = unsafe { self.get_unchecked_mut() };
</span><span class="boring"> this.b = self_ptr;
</span><span class="boring"> }
</span><span class="boring">
</span><span class="boring"> fn a&lt;'a&gt;(self: Pin&lt;&amp;'a Self&gt;) -&gt; &amp;'a str {
</span><span class="boring"> &amp;self.get_ref().a
</span><span class="boring"> }
</span><span class="boring">
</span><span class="boring"> fn b&lt;'a&gt;(self: Pin&lt;&amp;'a Self&gt;) -&gt; &amp;'a String {
</span><span class="boring"> assert!(!self.b.is_null(), &quot;Test::b called without Test::init being called first&quot;);
</span><span class="boring"> unsafe { &amp;*(self.b) }
</span><span class="boring"> }
</span><span class="boring">}</span></code></pre></pre>
</blockquote>
<h4 id="固定到堆上"><a class="header" href="#固定到堆上">固定到堆上</a></h4>
<p>将一个 <code>!Unpin</code> 类型的值固定到堆上，会给予该值一个稳定的内存地址，它指向的堆中的值在 <code>Pin</code> 后是无法被移动的。而且与固定在栈上不同，我们知道堆上的值在整个生命周期内都会被稳稳地固定住。</p>
<pre><pre class="playground"><code class="language-rust edition2021">use std::pin::Pin;
use std::marker::PhantomPinned;
#[derive(Debug)]
struct Test {
a: String,
b: *const String,
_marker: PhantomPinned,
}
impl Test {
fn new(txt: &amp;str) -&gt; Pin&lt;Box&lt;Self&gt;&gt; {
let t = Test {
a: String::from(txt),
b: std::ptr::null(),
_marker: PhantomPinned,
};
let mut boxed = Box::pin(t);
let self_ptr: *const String = &amp;boxed.as_ref().a;
unsafe { boxed.as_mut().get_unchecked_mut().b = self_ptr };
boxed
}
fn a(self: Pin&lt;&amp;Self&gt;) -&gt; &amp;str {
&amp;self.get_ref().a
}
fn b(self: Pin&lt;&amp;Self&gt;) -&gt; &amp;String {
unsafe { &amp;*(self.b) }
}
}
pub fn main() {
let test1 = Test::new(&quot;test1&quot;);
let test2 = Test::new(&quot;test2&quot;);
println!(&quot;a: {}, b: {}&quot;,test1.as_ref().a(), test1.as_ref().b());
println!(&quot;a: {}, b: {}&quot;,test2.as_ref().a(), test2.as_ref().b());
}</code></pre></pre>
<h4 id="将固定住的-future-变为-unpin"><a class="header" href="#将固定住的-future-变为-unpin">将固定住的 <code>Future</code> 变为 <code>Unpin</code></a></h4>
<p>之前的章节我们有提到 <code>async</code> 函数返回的 <code>Future</code> 默认就是 <code>!Unpin</code> 的。</p>
<p>但是，在实际应用中，一些函数会要求它们处理的 <code>Future</code> 是 <code>Unpin</code> 的，此时，若你使用的 <code>Future</code> 是 <code>!Unpin</code> 的，必须要使用以下的方法先将 <code>Future</code> 进行固定:</p>
<ul>
<li><code>Box::pin</code>， 创建一个 <code>Pin&lt;Box&lt;T&gt;&gt;</code></li>
<li><code>pin_utils::pin_mut!</code>， 创建一个 <code>Pin&lt;&amp;mut T&gt;</code></li>
</ul>
<p>固定后获得的 <code>Pin&lt;Box&lt;T&gt;&gt;</code> 和 <code>Pin&lt;&amp;mut T&gt;</code> 既可以用于 <code>Future</code> ，<strong>又会自动实现 <code>Unpin</code></strong>。</p>
<pre><pre class="playground"><code class="language-rust edition2021"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>use pin_utils::pin_mut; // `pin_utils` 可以在crates.io中找到
// 函数的参数是一个`Future`，但是要求该`Future`实现`Unpin`
fn execute_unpin_future(x: impl Future&lt;Output = ()&gt; + Unpin) { /* ... */ }
let fut = async { /* ... */ };
// 下面代码报错: 默认情况下，`fut` 实现的是`!Unpin`，并没有实现`Unpin`
// execute_unpin_future(fut);
// 使用`Box`进行固定
let fut = async { /* ... */ };
let fut = Box::pin(fut);
execute_unpin_future(fut); // OK
// 使用`pin_mut!`进行固定
let fut = async { /* ... */ };
pin_mut!(fut);
execute_unpin_future(fut); // OK
<span class="boring">}</span></code></pre></pre>
<h2 id="总结"><a class="header" href="#总结">总结</a></h2>
<p>相信大家看到这里，脑袋里已经快被 <code>Pin</code> 、 <code>Unpin</code> 、 <code>!Unpin</code> 整爆炸了，没事，我们再来火上浇油下:)</p>
<ul>
<li>若 <code>T: Unpin</code> ( Rust 类型的默认实现)，那么 <code>Pin&lt;'a, T&gt;</code> 跟 <code>&amp;'a mut T</code> 完全相同，也就是 <code>Pin</code> 将没有任何效果, 该移动还是照常移动</li>
<li>绝大多数标准库类型都实现了 <code>Unpin</code> ，事实上，对于 Rust 中你能遇到的绝大多数类型，该结论依然成立
，其中一个例外就是：<code>async/await</code> 生成的 <code>Future</code> 没有实现 <code>Unpin</code></li>
<li>你可以通过以下方法为自己的类型添加 <code>!Unpin</code> 约束：
<ul>
<li>使用文中提到的 <code>std::marker::PhantomPinned</code></li>
<li>使用<code>nightly</code> 版本下的 <code>feature flag</code></li>
</ul>
</li>
<li>可以将值固定到栈上，也可以固定到堆上
<ul>
<li>将 <code>!Unpin</code> 值固定到栈上需要使用 <code>unsafe</code></li>
<li>将 <code>!Unpin</code> 值固定到堆上无需 <code>unsafe</code> ，可以通过 <code>Box::pin</code> 来简单的实现</li>
</ul>
</li>
<li>当固定类型 <code>T: !Unpin</code> 时，你需要保证数据从被固定到被 drop 这段时期内，其内存不会变得非法或者被重用</li>
</ul>
<div id="giscus-container"></div>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../../advance/async/future-excuting.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../advance/async/async-await.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../../advance/async/future-excuting.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../../advance/async/async-await.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../../ace.js"></script>
<script src="../../editor.js"></script>
<script src="../../mode-rust.js"></script>
<script src="../../theme-dawn.js"></script>
<script src="../../theme-tomorrow_night.js"></script>
<script src="../../elasticlunr.min.js"></script>
<script src="../../mark.min.js"></script>
<script src="../../searcher.js"></script>
<script src="../../clipboard.min.js"></script>
<script src="../../highlight.js"></script>
<script src="../../book.js"></script>
<script type="text/javascript" charset="utf-8">
var pagePath = "advance/async/pin-unpin.md"
</script>
<!-- Custom JS scripts -->
<script src="../../assets/custom.js"></script>
<script src="../../assets/bigPicture.js"></script>
</div>
</body>
</html>