mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-03 00:44:33 +01:00
31 lines
17 KiB
HTML
31 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 custom implementation of a future trait object for `FutureObj`, providing a vtable with drop support."><title>UnsafeFutureObj in futures_util::task - 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="futures_util" 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 trait"><!--[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="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.31</span></h2></div><h2 class="location"><a href="#">Unsafe<wbr>Future<wbr>Obj</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.drop">drop</a></li><li><a href="#tymethod.into_raw">into_raw</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-%26mut+dyn+Future%3COutput+=+T%3E+%2B+Unpin">&'a mut (dyn Future<Output = T> + Unpin)</a></li><li><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-%26mut+F">&'a mut F</a></li><li><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+F%3E">Pin<&'a mut F></a></li><li><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+dyn+Future%3COutput+=+T%3E%3E">Pin<&'a mut dyn Future<Output = T>></a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In futures_<wbr>util::<wbr>task</a></h2></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>Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">task</a>::<wbr><a class="trait" href="#">UnsafeFutureObj</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/futures_task/future_obj.rs.html#141">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub unsafe trait UnsafeFutureObj<'a, T>: 'a {
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a;
|
||
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.drop" class="fn">drop</a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a);
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A custom implementation of a future trait object for <code>FutureObj</code>, providing
|
||
|
|
a vtable with drop support.</p>
|
||
|
|
<p>This custom representation is typically used only in <code>no_std</code> contexts,
|
||
|
|
where the default <code>Box</code>-based implementation is not available.</p>
|
||
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||
|
|
<p>See the safety notes on individual methods for what guarantees an
|
||
|
|
implementor must provide.</p>
|
||
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.into_raw" class="method"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#153">source</a><h4 class="code-header">fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</h4></section></summary><div class="docblock"><p>Convert an owned instance into a (conceptually owned) fat pointer.</p>
|
||
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5><h6 id="implementor"><a class="doc-anchor" href="#implementor">§</a>Implementor</h6>
|
||
|
|
<p>The trait implementor must guarantee that it is safe to convert the
|
||
|
|
provided <code>*mut (dyn Future<Output = T> + 'a)</code> into a <code>Pin<&mut (dyn Future<Output = T> + 'a)></code> and call methods on it, non-reentrantly,
|
||
|
|
until <code>UnsafeFutureObj::drop</code> is called with it.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.drop" class="method"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#173">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.drop" class="fn">drop</a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</h4></section></summary><div class="docblock"><p>Drops the future represented by the given fat pointer.</p>
|
||
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5><h6 id="implementor-1"><a class="doc-anchor" href="#implementor-1">§</a>Implementor</h6>
|
||
|
|
<p>The trait implementor must guarantee that it is safe to call this
|
||
|
|
function once per <code>into_raw</code> invocation.</p>
|
||
|
|
<h6 id="caller"><a class="doc-anchor" href="#caller">§</a>Caller</h6>
|
||
|
|
<p>The caller must ensure:</p>
|
||
|
|
<ul>
|
||
|
|
<li>the pointer passed was obtained from an <code>into_raw</code> invocation from
|
||
|
|
this same trait object</li>
|
||
|
|
<li>the pointer is not currently in use as a <code>Pin<&mut (dyn Future<Output = T> + 'a)></code></li>
|
||
|
|
<li>the pointer must not be used again after this function is called</li>
|
||
|
|
</ul>
|
||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.82.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-UnsafeFutureObj%3C'a,+T%3E-for-%26mut+dyn+Future%3COutput+=+T%3E+%2B+Unpin" class="impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#187">source</a><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-%26mut+dyn+Future%3COutput+=+T%3E+%2B+Unpin" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for &'a mut (dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>)</h3></section></summary><div class="impl-items"><section id="method.into_raw" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#188">source</a><a href="#method.into_raw" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</h4></section><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#192">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="#tymethod.drop" class="fn">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+dyn+Future%3COutput+=+T%3E%3E" class="impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#206">source</a><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+dyn+Future%3COutput+=+T%3E%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&'a mut dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>></h3></section></summary><div class="impl-items"><section id="method.into_raw-1" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#207">source</a><a href="#method.into_raw-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</h4></section><section id="method.drop-1" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#211">source</a><a href="
|
||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + 'a,</div></h3></section></summary><div class="impl-items"><section id="method.into_raw-2" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#180">source</a><a href="#method.into_raw-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</h4></section><section id="method.drop-2" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#184">source</a><a href="#method.drop-2" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="#tymethod.drop" class="fn">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+F%3E" class="impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#195-197">source</a><a href="#impl-UnsafeFutureObj%3C'a,+T%3E-for-Pin%3C%26mut+F%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, F> <a class="trait" href="trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for <a class="struct" href="https://doc.rust-lang.org/1.82.0/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&'a mut F</a>><div class="where">where
|
||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a,</div></h3></section></summary><div class="impl-items"><section id="method.into_raw-3" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#199">source</a><a href="#method.into_raw-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_raw" class="fn">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</h4></section><section id="method.drop-3" class="method trait-impl"><a class="src rightside" href="../../src/futures_task/future_obj.rs.html#203">source</a><a href="#method.drop-3" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="#tymethod.drop" class="fn">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/futures_task/future_obj/trait.UnsafeFutureObj.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>
|