17 lines
4.4 KiB
HTML
17 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="Marks the current thread as being within the dynamic extent of an executor."><title>enter in futures_executor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="futures_executor" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">enter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../futures_executor/index.html">futures_<wbr>executor</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">enter</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#error" title="Error">Error</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate futures_<wbr>executor</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">futures_executor</a></div><h1>Function <span class="fn">enter</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/futures_executor/enter.rs.html#55-65">Source</a> </span></div><pre class="rust item-decl"><code>pub fn enter() -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Enter.html" title="struct futures_executor::Enter">Enter</a>, <a class="struct" href="struct.EnterError.html" title="struct futures_executor::EnterError">EnterError</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Marks the current thread as being within the dynamic extent of an
|
||
executor.</p>
|
||
<p>Executor implementations should call this function before beginning to
|
||
execute a task, and drop the returned <a href="struct.Enter.html" title="struct futures_executor::Enter"><code>Enter</code></a> value after
|
||
completing task execution:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::executor::enter;
|
||
|
||
<span class="kw">let </span>enter = enter().expect(<span class="string">"..."</span>);
|
||
<span class="comment">/* run task */
|
||
</span>drop(enter);</code></pre></div>
|
||
<p>Doing so ensures that executors aren’t
|
||
accidentally invoked in a nested fashion.</p>
|
||
<h2 id="error"><a class="doc-anchor" href="#error">§</a>Error</h2>
|
||
<p>Returns an error if the current thread is already marked, in which case the
|
||
caller should panic with a tailored error message.</p>
|
||
</div></details></section></div></main></body></html> |