mirror of
https://github.com/fafhrd91/actix-net
synced 2024-11-30 18:44:36 +01:00
20 lines
6.2 KiB
HTML
20 lines
6.2 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="Creates a future driven by the provided function that receives a task context."><title>poll_fn in actix_utils::future - 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-b778ab399e080a4b.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_utils" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../actix_utils/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../actix_utils/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_utils/index.html">actix_<wbr>utils</a><span class="version">3.0.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">poll_fn</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In actix_<wbr>utils::<wbr>future</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">actix_utils</a>::<wbr><a href="index.html">future</a></span><h1>Function <span class="fn">poll_fn</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/actix_utils/future/poll_fn.rs.html#37-42">source</a> </span></div><pre class="rust item-decl"><code>pub fn poll_fn<F, T>(f: F) -> <a class="struct" href="struct.PollFn.html" title="struct actix_utils::future::PollFn">PollFn</a><F> <a href="#" class="tooltip" data-notable-ty="PollFn<F>">ⓘ</a><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><T>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a future driven by the provided function that receives a task context.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>res = poll_fn(|<span class="kw">_</span>| Poll::Ready(<span class="number">42</span>)).<span class="kw">await</span>;
|
|
<span class="macro">assert_eq!</span>(res, <span class="number">42</span>);
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">5</span>;
|
|
<span class="kw">let </span>res = poll_fn(|cx| {
|
|
i -= <span class="number">1</span>;
|
|
|
|
<span class="kw">if </span>i > <span class="number">0 </span>{
|
|
cx.waker().wake_by_ref();
|
|
Poll::Pending
|
|
} <span class="kw">else </span>{
|
|
Poll::Ready(<span class="number">42</span>)
|
|
}
|
|
})
|
|
.<span class="kw">await</span>;
|
|
<span class="macro">assert_eq!</span>(res, <span class="number">42</span>);</code></pre></div>
|
|
</div></details><script type="text/json" id="notable-traits-data">{"PollFn<F>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.PollFn.html\" title=\"struct actix_utils::future::PollFn\">PollFn</a><F></code></h3><pre><code><div class=\"where\">impl<F, T> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a> for <a class=\"struct\" href=\"struct.PollFn.html\" title=\"struct actix_utils::future::PollFn\">PollFn</a><F><div class=\"where\">where\n F: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html\" title=\"trait core::ops::function::FnMut\">FnMut</a>(&mut <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html\" title=\"struct core::task::wake::Context\">Context</a><'_>) -> <a class=\"enum\" href=\"https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html\" title=\"enum core::task::poll::Poll\">Poll</a><T>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = T;</div>"}</script></section></div></main></body></html> |