NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-18 00:38:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
pin_project_lite/all.html Normal file
View file

@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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="pin_project_lite" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../pin_project_lite/index.html">pin_<wbr>project_<wbr>lite</a><span class="version">0.2.15</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li></ul></section><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"><h1>List of all items</h1><h3 id="macros">Macros</h3><ul class="all-items"><li><a href="macro.pin_project.html">pin_project</a></li></ul></section></div></main></body></html>

77
pin_project_lite/index.html Normal file
View file

@ -0,0 +1,77 @@
<!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 lightweight version of pin-project written with declarative macros."><title>pin_project_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="pin_project_lite" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../pin_project_lite/index.html">pin_<wbr>project_<wbr>lite</a><span class="version">0.2.15</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a></li><li><a href="#examples" title="Examples">Examples</a></li><li><a href="#pin-project-vs-pin-project-lite" title="pin-project vs pin-project-lite">pin-project vs pin-project-lite</a><ul><li><a href="#similar-safety" title="Similar: Safety">Similar: Safety</a></li><li><a href="#different-minimal-design" title="Different: Minimal design">Different: Minimal design</a></li><li><a href="#different-no-proc-macro-related-dependencies" title="Different: No proc-macro related dependencies">Different: No proc-macro related dependencies</a></li><li><a href="#different-no-useful-error-messages" title="Different: No useful error messages">Different: No useful error messages</a></li><li><a href="#different-no-support-for-custom-unpin-implementation" title="Different: No support for custom Unpin implementation">Different: No support for custom Unpin implementation</a></li><li><a href="#different-no-support-for-tuple-structs-and-tuple-variants" title="Different: No support for tuple structs and tuple variants">Different: No support for tuple structs and tuple variants</a></li></ul></li></ul><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li></ul></section><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"><h1>Crate <span>pin_project_lite</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/pin_project_lite/lib.rs.html#3-1741">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><!-- tidy:crate-doc:start -->
<p>A lightweight version of <a href="https://github.com/taiki-e/pin-project">pin-project</a> written with declarative macros.</p>
<h3 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h3>
<p>Add this to your <code>Cargo.toml</code>:</p>
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
pin-project-lite = &quot;0.2&quot;</code></pre></div><h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3>
<p><a href="macro.pin_project.html" title="macro pin_project_lite::pin_project"><code>pin_project!</code></a> macro creates a projection type covering all the fields of
struct.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="kw">struct </span>Struct&lt;T, U&gt; {
<span class="attr">#[pin]
</span>pinned: T,
unpinned: U,
}
}
<span class="kw">impl</span>&lt;T, U&gt; Struct&lt;T, U&gt; {
<span class="kw">fn </span>method(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="kw">let </span>this = <span class="self">self</span>.project();
<span class="kw">let _</span>: Pin&lt;<span class="kw-2">&amp;mut </span>T&gt; = this.pinned; <span class="comment">// Pinned reference to the field
</span><span class="kw">let _</span>: <span class="kw-2">&amp;mut </span>U = this.unpinned; <span class="comment">// Normal reference to the field
</span>}
}</code></pre></div>
<p>To use <a href="macro.pin_project.html" title="macro pin_project_lite::pin_project"><code>pin_project!</code></a> 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>std::pin::Pin;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="attr">#[project = EnumProj]
</span><span class="kw">enum </span>Enum&lt;T, U&gt; {
Variant { <span class="attr">#[pin] </span>pinned: T, unpinned: U },
}
}
<span class="kw">impl</span>&lt;T, U&gt; Enum&lt;T, U&gt; {
<span class="kw">fn </span>method(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="kw">match </span><span class="self">self</span>.project() {
EnumProj::Variant { pinned, unpinned } =&gt; {
<span class="kw">let _</span>: Pin&lt;<span class="kw-2">&amp;mut </span>T&gt; = pinned;
<span class="kw">let _</span>: <span class="kw-2">&amp;mut </span>U = unpinned;
}
}
}
}</code></pre></div>
<h3 id="pin-project-vs-pin-project-lite"><a class="doc-anchor" href="#pin-project-vs-pin-project-lite">§</a><a href="https://github.com/taiki-e/pin-project">pin-project</a> vs pin-project-lite</h3>
<p>Here are some similarities and differences compared to <a href="https://github.com/taiki-e/pin-project">pin-project</a>.</p>
<h4 id="similar-safety"><a class="doc-anchor" href="#similar-safety">§</a>Similar: Safety</h4>
<p>pin-project-lite guarantees safety in much the same way as <a href="https://github.com/taiki-e/pin-project">pin-project</a>.
Both are completely safe unless you write other unsafe code.</p>
<h4 id="different-minimal-design"><a class="doc-anchor" href="#different-minimal-design">§</a>Different: Minimal design</h4>
<p>This library does not tackle as expansive of a range of use cases as
<a href="https://github.com/taiki-e/pin-project">pin-project</a> does. If your use case is not already covered, please use
<a href="https://github.com/taiki-e/pin-project">pin-project</a>.</p>
<h4 id="different-no-proc-macro-related-dependencies"><a class="doc-anchor" href="#different-no-proc-macro-related-dependencies">§</a>Different: No proc-macro related dependencies</h4>
<p>This is the <strong>only</strong> reason to use this crate. However, <strong>if you already
have proc-macro related dependencies in your crate’s dependency graph, there
is no benefit from using this crate.</strong> (Note: There is almost no difference
in the amount of code generated between <a href="https://github.com/taiki-e/pin-project">pin-project</a> and pin-project-lite.)</p>
<h4 id="different-no-useful-error-messages"><a class="doc-anchor" href="#different-no-useful-error-messages">§</a>Different: No useful error messages</h4>
<p>This macro does not handle any invalid input. So error messages are not to
be useful in most cases. If you do need useful error messages, then upon
error you can pass the same input to <a href="https://github.com/taiki-e/pin-project">pin-project</a> to receive a helpful
description of the compile error.</p>
<h4 id="different-no-support-for-custom-unpin-implementation"><a class="doc-anchor" href="#different-no-support-for-custom-unpin-implementation">§</a>Different: No support for custom Unpin implementation</h4>
<p>pin-project supports this by <a href="https://docs.rs/pin-project/latest/pin_project/attr.pin_project.html#unsafeunpin"><code>UnsafeUnpin</code></a>. (<code>!Unpin</code> is supported by both <a href="https://docs.rs/pin-project/latest/pin_project/attr.pin_project.html#unpin">pin-project</a> and <a href="macro.pin_project.html#unpin" title="macro pin_project_lite::pin_project">pin-project-lite</a>.)</p>
<h4 id="different-no-support-for-tuple-structs-and-tuple-variants"><a class="doc-anchor" href="#different-no-support-for-tuple-structs-and-tuple-variants">§</a>Different: No support for tuple structs and tuple variants</h4>
<p>pin-project supports this.</p>
<!-- tidy:crate-doc:end -->
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.pin_project.html" title="macro pin_project_lite::pin_project">pin_<wbr>project</a></div><div class="desc docblock-short">A macro that creates a projection type covering all the fields of struct.</div></li></ul></section></div></main></body></html>

11
pin_project_lite/macro.pin_project!.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.pin_project.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.pin_project.html">macro.pin_project.html</a>...</p>
<script>location.replace("macro.pin_project.html" + location.search + location.hash);</script>
</body>
</html>

183
pin_project_lite/macro.pin_project.html Normal file
View file

@ -0,0 +1,183 @@
<!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."><title>pin_project in pin_project_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="pin_project_lite" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" 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="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../pin_project_lite/index.html">pin_<wbr>project_<wbr>lite</a><span class="version">0.2.15</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pin_<wbr>project</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#examples" title="Examples">Examples</a></li><li><a href="#unpin" title="`!Unpin`"><code>!Unpin</code></a></li><li><a href="#pinned-drop" title="Pinned Drop">Pinned Drop</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate pin_<wbr>project_<wbr>lite</a></h2></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">pin_project_lite</a></span><h1>Macro <span class="macro">pin_project</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/pin_project_lite/lib.rs.html#382-389">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! pin_project {
($($tt:tt)*) =&gt; { ... };
}</code></pre><details class="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>project(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) -&gt; Projection&lt;<span class="lifetime">'_</span>&gt;;
<span class="kw">fn </span>project_ref(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;</span><span class="self">Self</span>&gt;) -&gt; ProjectionRef&lt;<span class="lifetime">'_</span>&gt;;</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="attr">#[project = EnumProj]
</span><span class="kw">enum </span>Enum&lt;T&gt; {
Variant { <span class="attr">#[pin] </span>field: T },
}
}
<span class="kw">impl</span>&lt;T&gt; Enum&lt;T&gt; {
<span class="kw">fn </span>method(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="kw">let </span>this: EnumProj&lt;<span class="lifetime">'_</span>, T&gt; = <span class="self">self</span>.project();
<span class="kw">match </span>this {
EnumProj::Variant { field } =&gt; {
<span class="kw">let _</span>: Pin&lt;<span class="kw-2">&amp;mut </span>T&gt; = field;
}
}
}
}</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&lt;&amp;mut Self&gt;</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>project_replace(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, replacement: <span class="self">Self</span>) -&gt; MyProjReplace;</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&lt;&#39;_, T&gt; = 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"><a class="doc-anchor" href="#safety">§</a>Safety</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"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="kw">struct </span>Struct&lt;T, U&gt; {
<span class="attr">#[pin]
</span>pinned: T,
unpinned: U,
}
}
<span class="kw">impl</span>&lt;T, U&gt; Struct&lt;T, U&gt; {
<span class="kw">fn </span>method(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="kw">let </span>this = <span class="self">self</span>.project();
<span class="kw">let _</span>: Pin&lt;<span class="kw-2">&amp;mut </span>T&gt; = this.pinned; <span class="comment">// Pinned reference to the field
</span><span class="kw">let _</span>: <span class="kw-2">&amp;mut </span>U = this.unpinned; <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>std::pin::Pin;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="attr">#[project = EnumProj]
</span><span class="kw">enum </span>Enum&lt;T&gt; {
Struct {
<span class="attr">#[pin]
</span>field: T,
},
Unit,
}
}
<span class="kw">impl</span>&lt;T&gt; Enum&lt;T&gt; {
<span class="kw">fn </span>method(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="kw">match </span><span class="self">self</span>.project() {
EnumProj::Struct { field } =&gt; {
<span class="kw">let _</span>: Pin&lt;<span class="kw-2">&amp;mut </span>T&gt; = field;
}
EnumProj::Unit =&gt; {}
}
}
}</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.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin"><code>Pin</code></a> type, it needs to use <a href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html#method.as_mut" title="method core::pin::Pin::as_mut"><code>.as_mut()</code></a> to avoid
consuming the <a href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin"><code>Pin</code></a>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="kw">struct </span>Struct&lt;T&gt; {
<span class="attr">#[pin]
</span>field: T,
}
}
<span class="kw">impl</span>&lt;T&gt; Struct&lt;T&gt; {
<span class="kw">fn </span>call_project_twice(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) {
<span class="comment">// `project` consumes `self`, so reborrow the `Pin&lt;&amp;mut Self&gt;` via `as_mut`.
</span><span class="self">self</span>.as_mut().project();
<span class="self">self</span>.as_mut().project();
}
}</code></pre></div>
<h2 id="unpin"><a class="doc-anchor" href="#unpin">§</a><code>!Unpin</code></h2>
<p>If you want to make sure <code>Unpin</code> is not implemented, use the <code>#[project(!Unpin)]</code>
attribute.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="attr">#[project(!Unpin)]
</span><span class="kw">struct </span>Struct&lt;T&gt; {
<span class="attr">#[pin]
</span>field: T,
}
}</code></pre></div>
<p>This is equivalent to using <code>#[pin]</code> attribute for a <a href="https://doc.rust-lang.org/1.84.1/core/marker/struct.PhantomPinned.html" title="struct core::marker::PhantomPinned"><code>PhantomPinned</code></a> field.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::marker::PhantomPinned;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="kw">struct </span>Struct&lt;T&gt; {
field: T,
<span class="attr">#[pin]
</span>_pin: PhantomPinned,
}
}</code></pre></div>
<p>Note that using <a href="https://doc.rust-lang.org/1.84.1/core/marker/struct.PhantomPinned.html" title="struct core::marker::PhantomPinned"><code>PhantomPinned</code></a> without <code>#[pin]</code> or <code>#[project(!Unpin)]</code>
attribute has no effect.</p>
<h2 id="pinned-drop"><a class="doc-anchor" href="#pinned-drop">§</a>Pinned Drop</h2>
<p>In order to correctly implement pin projections, a type’s <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop"><code>Drop</code></a> impl must not move out of any
structurally pinned fields. Unfortunately, <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html#tymethod.drop" title="method core::ops::drop::Drop::drop"><code>Drop::drop</code></a> takes <code>&amp;mut Self</code>, not <code>Pin&lt;&amp;mut Self&gt;</code>.</p>
<p>To implement <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop"><code>Drop</code></a> for type that has pin, add an <code>impl PinnedDrop</code> block at the end of the
<a href="macro.pin_project.html" title="macro pin_project_lite::pin_project"><code>pin_project</code></a> macro block. PinnedDrop has the following interface:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">trait </span>PinnedDrop {
<span class="kw">fn </span>drop(this: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;);
}</code></pre></div>
<p>Note that the argument to <code>PinnedDrop::drop</code> cannot be named <code>self</code>.</p>
<p><code>pin_project!</code> implements the actual <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop"><code>Drop</code></a> trait via PinnedDrop you implemented. To
explicitly drop a type that implements PinnedDrop, use the <a href="https://doc.rust-lang.org/1.84.1/core/mem/fn.drop.html" title="fn core::mem::drop">drop</a> function just like dropping a
type that directly implements <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop"><code>Drop</code></a>.</p>
<p><code>PinnedDrop::drop</code> will never be called more than once, just like <a href="https://doc.rust-lang.org/1.84.1/core/ops/drop/trait.Drop.html#tymethod.drop" title="method core::ops::drop::Drop::drop"><code>Drop::drop</code></a>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project!</span> {
<span class="kw">pub struct </span>Struct&lt;<span class="lifetime">'a</span>&gt; {
was_dropped: <span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="kw-2">mut </span>bool,
<span class="attr">#[pin]
</span>field: u8,
}
<span class="kw">impl </span>PinnedDrop <span class="kw">for </span>Struct&lt;<span class="lifetime">'_</span>&gt; {
<span class="kw">fn </span>drop(this: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;) { <span class="comment">// &lt;----- NOTE: this is not `self`
</span><span class="kw-2">**</span>this.project().was_dropped = <span class="bool-val">true</span>;
}
}
}
<span class="kw">let </span><span class="kw-2">mut </span>was_dropped = <span class="bool-val">false</span>;
drop(Struct { was_dropped: <span class="kw-2">&amp;mut </span>was_dropped, field: <span class="number">42 </span>});
<span class="macro">assert!</span>(was_dropped);</code></pre></div>
</div></details></section></div></main></body></html>

1
pin_project_lite/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"macro":["pin_project"]};