<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A lightweight version of pin-project written with declarative macros."><title>pin_project_lite - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="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.77.2 (25ef9e3d8 2024-04-09)"data-channel="1.77.2"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../pin_project_lite/index.html">pin_project_lite</a><spanclass="version">0.2.14</span></h2></div><divclass="sidebar-elems"><ulclass="block">
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../pin_project_lite/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Crate <aclass="mod"href="#">pin_project_lite</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/pin_project_lite/lib.rs.html#3-1729">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><!-- tidy:crate-doc:start -->
<p><ahref="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
<spanclass="kw">let _</span>: Pin<<spanclass="kw-2">&mut </span>T> = this.pinned; <spanclass="comment">// Pinned reference to the field
</span><spanclass="kw">let _</span>: <spanclass="kw-2">&mut </span>U = this.unpinned; <spanclass="comment">// Normal reference to the field
</span>}
}</code></pre></div>
<p>To use <ahref="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
<h3id="pin-project-vs-pin-project-lite"><aclass="doc-anchor"href="#pin-project-vs-pin-project-lite">§</a><ahref="https://github.com/taiki-e/pin-project">pin-project</a> vs pin-project-lite</h3>
<h4id="different-no-proc-macro-related-dependencies"><aclass="doc-anchor"href="#different-no-proc-macro-related-dependencies">§</a>Different: No proc-macro related dependencies</h4>
<h4id="different-no-useful-error-messages"><aclass="doc-anchor"href="#different-no-useful-error-messages">§</a>Different: No useful error messages</h4>
<h4id="different-no-support-for-custom-unpin-implementation"><aclass="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 <ahref="https://docs.rs/pin-project/1/pin_project/attr.pin_project.html#unsafeunpin"><code>UnsafeUnpin</code></a>. (<code>!Unpin</code> is supported by both <ahref="https://docs.rs/pin-project/1/pin_project/attr.pin_project.html#unpin">pin-project</a> and <ahref="https://docs.rs/pin-project-lite/0.2/pin_project_lite/macro.pin_project.html#unpin">pin-project-lite</a>.)</p>
<h4id="different-no-support-for-tuple-structs-and-tuple-variants"><aclass="doc-anchor"href="#different-no-support-for-tuple-structs-and-tuple-variants">§</a>Different: No support for tuple structs and tuple variants</h4>
<!-- tidy:crate-doc:end --></div></details><h2id="macros"class="section-header">Macros<ahref="#macros"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="macro"href="macro.pin_project.html"title="macro pin_project_lite::pin_project">pin_project</a></div><divclass="desc docblock-short">A macro that creates a projection type covering all the fields of struct.</div></li></ul></section></div></main></body></html>
