mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-11 20:57:16 +01:00
33 lines
No EOL
5.6 KiB
HTML
33 lines
No EOL
5.6 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 pinned projection of a struct field."><title>unsafe_pinned in pin_utils - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="pin_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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_utils/index.html">pin_<wbr>utils</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">unsafe_<wbr>pinned</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="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate pin_<wbr>utils</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_utils</a></span><h1>Macro <span class="macro">unsafe_pinned</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_utils/projection.rs.html#40-53">source</a> </span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> unsafe_pinned {
|
||
(<span class="macro-nonterminal">$f</span>:tt: <span class="macro-nonterminal">$t</span>:ty) => { ... };
|
||
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A pinned projection of a struct field.</p>
|
||
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||
<p>To make using this macro safe, three things need to be ensured:</p>
|
||
<ul>
|
||
<li>If the struct implements <a href="https://doc.rust-lang.org/1.83.0/core/ops/drop/trait.Drop.html#tymethod.drop" title="method core::ops::drop::Drop::drop"><code>Drop</code></a>, the <a href="https://doc.rust-lang.org/1.83.0/core/ops/drop/trait.Drop.html#tymethod.drop" title="method core::ops::drop::Drop::drop"><code>drop</code></a> method is not allowed to
|
||
move the value of the field.</li>
|
||
<li>If the struct wants to implement <a href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin"><code>Unpin</code></a>, it has to do so conditionally:
|
||
The struct can only implement <a href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin"><code>Unpin</code></a> if the field’s type is <a href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin"><code>Unpin</code></a>.</li>
|
||
<li>The struct must not be <code>#[repr(packed)]</code>.</li>
|
||
</ul>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>pin_utils::unsafe_pinned;
|
||
<span class="kw">use </span>std::marker::Unpin;
|
||
<span class="kw">use </span>std::pin::Pin;
|
||
|
||
<span class="kw">struct </span>Foo<T> {
|
||
field: T,
|
||
}
|
||
|
||
<span class="kw">impl</span><T> Foo<T> {
|
||
<span class="macro">unsafe_pinned!</span>(field: T);
|
||
|
||
<span class="kw">fn </span>baz(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>) {
|
||
<span class="kw">let _</span>: Pin<<span class="kw-2">&mut </span>T> = <span class="self">self</span>.field(); <span class="comment">// Pinned reference to the field
|
||
</span>}
|
||
}
|
||
|
||
<span class="kw">impl</span><T: Unpin> Unpin <span class="kw">for </span>Foo<T> {} <span class="comment">// Conditional Unpin impl</span></code></pre></div>
|
||
<p>Note: borrowing the field multiple times requires using <code>.as_mut()</code> to
|
||
avoid consuming the <code>Pin</code>.</p>
|
||
</div></details></section></div></main></body></html> |