<!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 `UnsafeTask` trait in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, UnsafeTask"><title>std::task::UnsafeTask - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></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='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Trait UnsafeTask</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.into_raw">into_raw</a><a href="#tymethod.poll">poll</a><a href="#tymethod.drop">drop</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>task</a></p><script>window.sidebarCurrent = {name: 'UnsafeTask', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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'>std</a>::<wbr><a href='index.html'>task</a>::<wbr><a class="trait" href=''>UnsafeTask</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><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/core/task.rs.html#482-503' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub unsafe trait UnsafeTask: 'static + <a class="trait" href="../../std/marker/trait.Send.html" title="trait std::marker::Send">Send</a> {
fn <a href='#tymethod.into_raw' class='fnname'>into_raw</a>(self) -> <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a>;
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.poll' class='fnname'>poll</a>(task: <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a>, cx: &mut <a class="struct" href="../../std/task/struct.Context.html" title="struct std::task::Context">Context</a>) -> <a class="enum" href="../../std/task/enum.Poll.html" title="enum std::task::Poll">Poll</a><<a class="primitive" href="../primitive.unit.html">()</a>>;
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.drop' class='fnname'>drop</a>(task: <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a>);
}</pre></div><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>A custom implementation of a task trait object for <code>TaskObj</code>, providing
a hand-rolled vtable.</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>
<p>The implementor must guarantee that it is safe to call <code>poll</code> repeatedly (in
a non-concurrent fashion) with the result of <code>into_raw</code> until <code>drop</code> is
called.</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'><span id='into_raw.v' class='invisible'><code>fn <a href='#tymethod.into_raw' class='fnname'>into_raw</a>(self) -> <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>Convert a owned instance into a (conceptually owned) void pointer.</p>
</div><h3 id='tymethod.poll' class='method'><span id='poll.v' class='invisible'><code>unsafe fn <a href='#tymethod.poll' class='fnname'>poll</a>(task: <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a>, cx: &mut <a class="struct" href="../../std/task/struct.Context.html" title="struct std::task::Context">Context</a>) -> <a class="enum" href="../../std/task/enum.Poll.html" title="enum std::task::Poll">Poll</a><<a class="primitive" href="../primitive.unit.html">()</a>></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>Poll the task represented by the given void pointer.</p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<p>The trait implementor must guarantee that it is safe to repeatedly call
<code>poll</code> with the result of <code>into_raw</code> until <code>drop</code> is called; such calls
are not, however, allowed to race with each other or with calls to <code>drop</code>.</p>
</div><h3 id='tymethod.drop' class='method'><span id='drop.v' class='invisible'><code>unsafe fn <a href='#tymethod.drop' class='fnname'>drop</a>(task: <a class="primitive" href="../primitive.pointer.html">*mut </a><a class="primitive" href="../primitive.unit.html">()</a>)</code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>futures_api </code><a href="https://github.com/rust-lang/rust/issues/50547">#50547</a>)</summary><p>futures in libcore are unstable</p>
</details></div></div><div class='docblock'><p>Drops the task represented by the given void pointer.</p>
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
<p>The trait implementor must guarantee that it is safe to call this
function once per <code>into_raw</code> invocation; that call cannot race with
other calls to <code>drop</code> or <code>poll</code>.</p>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><table class='table-display'><tbody><tr><td><code>impl<F> UnsafeTask for <a class="struct" href="../../std/boxed/struct.PinBox.html" title="struct std::boxed::PinBox">PinBox</a><F> <span class="where fmt-newline">where<br> F: 'static + <a class="trait" href="../../std/marker/trait.Send.html" title="trait std::marker::Send">Send</a> + <a class="trait" href="../../std/future/trait.Future.html" title="trait std::future::Future">Future</a><Output = <a class="primitive" href="../primitive.unit.html">()</a>>, </span></code><td><div class='out-of-band'><a class='srclink' href='../../src/alloc/boxed.rs.html#936-950' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/core/task/trait.UnsafeTask.js">
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
4e2dbb669434a7691662cb2f0ad38972
>
files
>
15056
