141 lines
17 KiB
HTML
141 lines
17 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="A macro that creates a projection type covering all the fields of struct."><meta name="keywords" content="rust, rustlang, rust-lang, pin_project"><title>pin_project in pin_project_lite - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../pin_project_lite/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">pin_project_lite</a></h2><div id="sidebar-vars" data-name="pin_project" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../pin_project_lite/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">pin_project_lite</a>::<wbr><a class="macro" href="#">pin_project</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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 class="srclink" href="../src/pin_project_lite/lib.rs.html#291-298" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">pin_project</span> {
|
||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span> : <span class="ident">tt</span>) <span class="kw-2">*</span>) => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A macro that creates a projection type covering all the fields of struct.</p>
|
||
<p>This macro creates a projection type according to the following rules:</p>
|
||
<ul>
|
||
<li>For the field that uses <code>#[pin]</code> attribute, makes the pinned reference to the field.</li>
|
||
<li>For the other fields, makes the unpinned reference to the field.</li>
|
||
</ul>
|
||
<p>And the following methods are implemented on the original type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn</span> <span class="ident">project</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>) -> <span class="ident">Projection</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>;
|
||
<span class="kw">fn</span> <span class="ident">project_ref</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&</span><span class="self">Self</span><span class="op">></span>) -> <span class="ident">ProjectionRef</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>;</code></pre></div>
|
||
<p>By passing an attribute with the same name as the method to the macro,
|
||
you can name the projection type returned from the method. This allows you
|
||
to use pattern matching on the projected types.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">pin_project!</span> {
|
||
<span class="attribute">#[<span class="ident">project</span> <span class="op">=</span> <span class="ident">EnumProj</span>]</span>
|
||
<span class="kw">enum</span> <span class="ident">Enum</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="ident">Variant</span> { <span class="attribute">#[<span class="ident">pin</span>]</span> <span class="ident">field</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">Enum</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">method</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>) {
|
||
<span class="kw">let</span> <span class="ident">this</span>: <span class="ident">EnumProj</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">project</span>();
|
||
<span class="kw">match</span> <span class="ident">this</span> {
|
||
<span class="ident">EnumProj::Variant</span> { <span class="ident">field</span> } => {
|
||
<span class="kw">let</span> <span class="kw">_</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">field</span>;
|
||
}
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
<p>By passing the <code>#[project_replace = MyProjReplace]</code> attribute you may create an additional
|
||
method which allows the contents of <code>Pin<&mut Self></code> to be replaced while simultaneously moving
|
||
out all unpinned fields in <code>Self</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn</span> <span class="ident">project_replace</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>, <span class="ident">replacement</span>: <span class="self">Self</span>) -> <span class="ident">MyProjReplace</span>;</code></pre></div>
|
||
<p>Also, note that the projection types returned by <code>project</code> and <code>project_ref</code> have
|
||
an additional lifetime at the beginning of generics.</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>let this: EnumProj<'_, T> = self.project();
|
||
^^</code></pre></div>
|
||
<p>The visibility of the projected types and projection methods is based on the
|
||
original type. However, if the visibility of the original type is <code>pub</code>, the
|
||
visibility of the projected types and the projection methods is downgraded
|
||
to <code>pub(crate)</code>.</p>
|
||
<h2 id="safety" class="section-header"><a href="#safety">Safety</a></h2>
|
||
<p><code>pin_project!</code> macro guarantees safety in much the same way as <a href="https://github.com/taiki-e/pin-project">pin-project</a> crate.
|
||
Both are completely safe unless you write other unsafe code.</p>
|
||
<p>See <a href="https://github.com/taiki-e/pin-project">pin-project</a> crate for more details.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::pin::Pin</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">pin_project_lite::pin_project</span>;
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="kw">struct</span> <span class="ident">Struct</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span>
|
||
<span class="ident">pinned</span>: <span class="ident">T</span>,
|
||
<span class="ident">unpinned</span>: <span class="ident">U</span>,
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> <span class="ident">Struct</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">U</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">method</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>) {
|
||
<span class="kw">let</span> <span class="ident">this</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">project</span>();
|
||
<span class="kw">let</span> <span class="kw">_</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">this</span>.<span class="ident">pinned</span>; <span class="comment">// Pinned reference to the field</span>
|
||
<span class="kw">let</span> <span class="kw">_</span>: <span class="kw-2">&mut</span> <span class="ident">U</span> <span class="op">=</span> <span class="ident">this</span>.<span class="ident">unpinned</span>; <span class="comment">// Normal reference to the field</span>
|
||
}
|
||
}</code></pre></div>
|
||
<p>To use <code>pin_project!</code> on enums, you need to name the projection type
|
||
returned from the method.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::pin::Pin</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">pin_project_lite::pin_project</span>;
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="attribute">#[<span class="ident">project</span> <span class="op">=</span> <span class="ident">EnumProj</span>]</span>
|
||
<span class="kw">enum</span> <span class="ident">Enum</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="ident">Struct</span> {
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span>
|
||
<span class="ident">field</span>: <span class="ident">T</span>,
|
||
},
|
||
<span class="ident">Unit</span>,
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Enum</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">method</span>(<span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>) {
|
||
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">project</span>() {
|
||
<span class="ident">EnumProj::Struct</span> { <span class="ident">field</span> } => {
|
||
<span class="kw">let</span> <span class="kw">_</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="ident">field</span>;
|
||
}
|
||
<span class="ident">EnumProj::Unit</span> => {}
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
<p>If you want to call the <code>project()</code> method multiple times or later use the
|
||
original <a href="https://doc.rust-lang.org/1.59.0/core/pin/struct.Pin.html"><code>Pin</code></a> type, it needs to use <a href="https://doc.rust-lang.org/1.59.0/core/pin/struct.Pin.html#method.as_mut"><code>.as_mut()</code></a> to avoid
|
||
consuming the <a href="https://doc.rust-lang.org/1.59.0/core/pin/struct.Pin.html"><code>Pin</code></a>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::pin::Pin</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">pin_project_lite::pin_project</span>;
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="kw">struct</span> <span class="ident">Struct</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span>
|
||
<span class="ident">field</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">Struct</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">call_project_twice</span>(<span class="kw-2">mut</span> <span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>) {
|
||
<span class="comment">// `project` consumes `self`, so reborrow the `Pin<&mut Self>` via `as_mut`.</span>
|
||
<span class="self">self</span>.<span class="ident">as_mut</span>().<span class="ident">project</span>();
|
||
<span class="self">self</span>.<span class="ident">as_mut</span>().<span class="ident">project</span>();
|
||
}
|
||
}</code></pre></div>
|
||
<h2 id="unpin" class="section-header"><a href="#unpin"><code>!Unpin</code></a></h2>
|
||
<p>If you want to ensure that <a href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Unpin.html" title="Unpin"><code>Unpin</code></a> is not implemented, use <code>#[pin]</code>
|
||
attribute for a <a href="https://doc.rust-lang.org/1.59.0/core/marker/struct.PhantomPinned.html"><code>PhantomPinned</code></a> field.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::marker::PhantomPinned</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">pin_project_lite::pin_project</span>;
|
||
|
||
<span class="macro">pin_project!</span> {
|
||
<span class="kw">struct</span> <span class="ident">Struct</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||
<span class="ident">field</span>: <span class="ident">T</span>,
|
||
<span class="attribute">#[<span class="ident">pin</span>]</span> <span class="comment">// <------ This `#[pin]` is required to make `Struct` to `!Unpin`.</span>
|
||
<span class="ident">_pin</span>: <span class="ident">PhantomPinned</span>,
|
||
}
|
||
}</code></pre></div>
|
||
<p>Note that using <a href="https://doc.rust-lang.org/1.59.0/core/marker/struct.PhantomPinned.html"><code>PhantomPinned</code></a> without <code>#[pin]</code> attribute has no effect.</p>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="pin_project_lite" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |