mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-26 05:29:38 +01:00
27 lines
4.4 KiB
HTML
27 lines
4.4 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="An unpinned projection of a struct field."><title>unsafe_unpinned 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-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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"></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>Macro <a href="index.html">pin_utils</a>::<wbr><a class="macro" href="#">unsafe_unpinned</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/pin_utils/projection.rs.html#89-100">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> unsafe_unpinned {
|
||
|
|
(<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>An unpinned projection of a struct field.</p>
|
||
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||
|
|
<p>This macro is unsafe because it creates a method that returns a normal
|
||
|
|
non-pin reference to the struct field. It is up to the programmer to ensure
|
||
|
|
that the contained value can be considered not pinned in the current
|
||
|
|
context.</p>
|
||
|
|
<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_unpinned;
|
||
|
|
<span class="kw">use </span>std::pin::Pin;
|
||
|
|
|
||
|
|
<span class="kw">struct </span>Bar;
|
||
|
|
<span class="kw">struct </span>Foo {
|
||
|
|
field: Bar,
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">impl </span>Foo {
|
||
|
|
<span class="macro">unsafe_unpinned!</span>(field: Bar);
|
||
|
|
|
||
|
|
<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>: <span class="kw-2">&mut </span>Bar = <span class="self">self</span>.field(); <span class="comment">// Normal reference to the field
|
||
|
|
</span>}
|
||
|
|
}</code></pre></div>
|
||
|
|
<p>Note: borrowing the field multiple times requires using <code>.as_mut()</code> to
|
||
|
|
avoid consuming the <a href="https://doc.rust-lang.org/1.82.0/core/pin/struct.Pin.html" title="struct core::pin::Pin"><code>Pin</code></a>.</p>
|
||
|
|
</div></details></section></div></main></body></html>
|