github-actions[bot]
32 lines
17 KiB
HTML
32 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="API documentation for the Rust `UnsafeFutureObj` trait in crate `futures_util`."><meta name="keywords" content="rust, rustlang, rust-lang, UnsafeFutureObj"><title>futures_util::task::UnsafeFutureObj - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../futures_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait UnsafeFutureObj</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.drop">drop</a><a href="#tymethod.into_raw">into_raw</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a%20+%20Unpin)">&'a mut (dyn Future<Output = T> + 'a + Unpin)</a><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20F">&'a mut F</a><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a)%3E">Pin<&'a mut (dyn Future<Output = T> + 'a)></a><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20F%3E">Pin<&'a mut F></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">task</a></p><div id="sidebar-vars" data-name="UnsafeFutureObj" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">task</a>::<wbr><a class="trait" href="">UnsafeFutureObj</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/futures_task/future_obj.rs.html#147-179" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub unsafe trait UnsafeFutureObj<'a, T>: 'a {
|
||
pub fn <a href="#tymethod.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a;
|
||
<div class="item-spacer"></div> pub unsafe fn <a href="#tymethod.drop" class="fnname">drop</a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a);
|
||
}</pre></div><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>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>See the safety notes on individual methods for what guarantees an
|
||
implementor must provide.</p>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.into_raw" class="method"><code>pub fn <a href="#tymethod.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#158" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert an owned instance into a (conceptually owned) fat pointer.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1><h2 id="implementor" class="section-header"><a href="#implementor">Implementor</a></h2>
|
||
<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><h3 id="tymethod.drop" class="method"><code>pub unsafe fn <a href="#tymethod.drop" class="fnname">drop</a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#178" title="goto source code">[src]</a></h3><div class="docblock"><p>Drops the future represented by the given fat pointer.</p>
|
||
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1><h2 id="implementor-1" class="section-header"><a href="#implementor-1">Implementor</a></h2>
|
||
<p>The trait implementor must guarantee that it is safe to call this
|
||
function once per <code>into_raw</code> invocation.</p>
|
||
<h2 id="caller" class="section-header"><a href="#caller">Caller</a></h2>
|
||
<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></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20F%3E" class="impl"><code class="in-band">impl<'a, T, F> <a class="trait" href="../../futures_util/task/trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a, </span></code><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20F%3E" class="anchor"></a><a class="srclink" href="../../src/futures_task/future_obj.rs.html#201-210" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_raw" class="method hidden"><code>pub fn <a href="#method.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#205" title="goto source code">[src]</a></h4><h4 id="method.drop" class="method hidden"><code>pub unsafe fn <a href="#method.drop" class="fnname">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#209" title="goto source code">[src]</a></h4></div><h3 id="impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a%20+%20Unpin)" class="impl"><code class="in-band">impl<'a, T> <a class="trait" href="../../futures_util/task/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/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>)</code><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a%20+%20Unpin)" class="anchor"></a><a class="srclink" href="../../src/futures_task/future_obj.rs.html#192-199" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_raw-1" class="method hidden"><code>pub fn <a href="#method.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#194" title="goto source code">[src]</a></h4><h4 id="method.drop-1" class="method hidden"><code>pub unsafe fn <a href="#method.drop" class="fnname">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#198" title="goto source code">[src]</a></h4></div><h3 id="impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a)%3E" class="impl"><code class="in-band">impl<'a, T> <a class="trait" href="../../futures_util/task/trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&'a mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)></code><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-Pin%3C%26%27a%20mut%20(dyn%20Future%3COutput%20=%20T%3E%20+%20%27a)%3E" class="anchor"></a><a class="srclink" href="../../src/futures_task/future_obj.rs.html#212-219" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_raw-2" class="method hidden"><code>pub fn <a href="#method.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#214" title="goto source code">[src]</a></h4><h4 id="method.drop-2" class="method hidden"><code>pub unsafe fn <a href="#method.drop" class="fnname">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#218" title="goto source code">[src]</a></h4></div><h3 id="impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20F" class="impl"><code class="in-band">impl<'a, T, F> <a class="trait" href="../../futures_util/task/trait.UnsafeFutureObj.html" title="trait futures_util::task::UnsafeFutureObj">UnsafeFutureObj</a><'a, T> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/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/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + 'a, </span></code><a href="#impl-UnsafeFutureObj%3C%27a%2C%20T%3E-for-%26%27a%20mut%20F" class="anchor"></a><a class="srclink" href="../../src/futures_task/future_obj.rs.html#181-190" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into_raw-3" class="method hidden"><code>pub fn <a href="#method.into_raw" class="fnname">into_raw</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#185" title="goto source code">[src]</a></h4><h4 id="method.drop-3" class="method hidden"><code>pub unsafe fn <a href="#method.drop" class="fnname">drop</a>(_ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T> + 'a)</code><a class="srclink" href="../../src/futures_task/future_obj.rs.html#189" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/futures_task/future_obj/trait.UnsafeFutureObj.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_util"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |