20 lines
No EOL
14 KiB
HTML
20 lines
No EOL
14 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 type that can run futures."><title>Executor in cosmic::iced - 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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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="../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Executor</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.block_on" title="block_on">block_on</a></li><li><a href="#tymethod.new" title="new">new</a></li><li><a href="#tymethod.spawn" title="spawn">spawn</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.enter" title="enter">enter</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Executor-for-Runtime" title="Runtime">Runtime</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>iced</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">cosmic</a>::<wbr><a href="index.html">iced</a></div><h1>Trait <span class="trait">Executor</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait Executor: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.new" class="fn">new</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="daemon/program/graphics/futures/futures/io/struct.Error.html" title="struct cosmic::iced::daemon::program::graphics::futures::futures::io::Error">Error</a>>
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.spawn" class="fn">spawn</a>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + <a class="trait" href="daemon/program/graphics/futures/trait.MaybeSend.html" title="trait cosmic::iced::daemon::program::graphics::futures::MaybeSend">MaybeSend</a> + 'static);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.block_on" class="fn">block_on</a><T>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = T>) -> T;
|
|
|
|
// Provided method
|
|
fn <a href="#method.enter" class="fn">enter</a><R>(&self, f: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> R) -> R { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type that can run futures.</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.new" class="method"><h4 class="code-header">fn <a href="#tymethod.new" class="fn">new</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="daemon/program/graphics/futures/futures/io/struct.Error.html" title="struct cosmic::iced::daemon::program::graphics::futures::futures::io::Error">Error</a>><div class="where">where
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Creates a new <a href="trait.Executor.html" title="trait cosmic::iced::Executor"><code>Executor</code></a>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.spawn" class="method"><h4 class="code-header">fn <a href="#tymethod.spawn" class="fn">spawn</a>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + <a class="trait" href="daemon/program/graphics/futures/trait.MaybeSend.html" title="trait cosmic::iced::daemon::program::graphics::futures::MaybeSend">MaybeSend</a> + 'static)</h4></section></summary><div class="docblock"><p>Spawns a future in the <a href="trait.Executor.html" title="trait cosmic::iced::Executor"><code>Executor</code></a>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.block_on" class="method"><h4 class="code-header">fn <a href="#tymethod.block_on" class="fn">block_on</a><T>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = T>) -> T</h4></section></summary><div class="docblock"><p>Runs a future to completion in the current thread within the <a href="trait.Executor.html" title="trait cosmic::iced::Executor"><code>Executor</code></a>.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.enter" class="method"><h4 class="code-header">fn <a href="#method.enter" class="fn">enter</a><R>(&self, f: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> R) -> R</h4></section></summary><div class="docblock"><p>Runs the given closure inside the <a href="trait.Executor.html" title="trait cosmic::iced::Executor"><code>Executor</code></a>.</p>
|
|
<p>Some executors, like <code>tokio</code>, require some global state to be in place
|
|
before creating futures. This method can be leveraged to set up this
|
|
global state, call a function, restore the state, and obtain the result
|
|
of the call.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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-Executor-for-Runtime" class="impl"><a href="#impl-Executor-for-Runtime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Executor.html" title="trait cosmic::iced::Executor">Executor</a> for Runtime</h3></section></summary><div class="impl-items"><section id="method.new" class="method trait-impl"><a href="#method.new" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.new" class="fn">new</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Runtime, <a class="struct" href="daemon/program/graphics/futures/futures/io/struct.Error.html" title="struct cosmic::iced::daemon::program::graphics::futures::futures::io::Error">Error</a>></h4></section><section id="method.spawn" class="method trait-impl"><a href="#method.spawn" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.spawn" class="fn">spawn</a>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static)</h4></section><section id="method.enter-1" class="method trait-impl"><a href="#method.enter-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.enter" class="fn">enter</a><R>(&self, f: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> R) -> R</h4></section><section id="method.block_on" class="method trait-impl"><a href="#method.block_on" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.block_on" class="fn">block_on</a><T>(&self, future: impl <a class="trait" href="daemon/program/graphics/futures/futures/trait.Future.html" title="trait cosmic::iced::daemon::program::graphics::futures::futures::Future">Future</a><Output = T>) -> T</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Executor-for-Executor" class="impl"><a class="src rightside" href="../../src/cosmic/executor/multi.rs.html#12-33">Source</a><a href="#impl-Executor-for-Executor" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Executor.html" title="trait cosmic::iced::Executor">Executor</a> for cosmic::executor::multi::<a class="struct" href="../executor/multi/struct.Executor.html" title="struct cosmic::executor::multi::Executor">Executor</a></h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>tokio</code></strong> only.</div></span></section><section id="impl-Executor-for-Executor-1" class="impl"><a class="src rightside" href="../../src/cosmic/executor/single.rs.html#12-37">Source</a><a href="#impl-Executor-for-Executor-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Executor.html" title="trait cosmic::iced::Executor">Executor</a> for cosmic::executor::single::<a class="struct" href="../executor/single/struct.Executor.html" title="struct cosmic::executor::single::Executor">Executor</a></h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>tokio</code></strong> only.</div></span></section><section id="impl-Executor-for-Executor-2" class="impl"><a href="#impl-Executor-for-Executor-2" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Executor.html" title="trait cosmic::iced::Executor">Executor</a> for cosmic::iced::daemon::program::graphics::futures::backend::null::<a class="struct" href="daemon/program/graphics/futures/backend/null/struct.Executor.html" title="struct cosmic::iced::daemon::program::graphics::futures::backend::null::Executor">Executor</a></h3></section><section id="impl-Executor-for-ThreadPool" class="impl"><a href="#impl-Executor-for-ThreadPool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Executor.html" title="trait cosmic::iced::Executor">Executor</a> for <a class="struct" href="daemon/program/graphics/futures/futures/executor/struct.ThreadPool.html" title="struct cosmic::iced::daemon::program::graphics::futures::futures::executor::ThreadPool">ThreadPool</a></h3></section></div><script src="../../trait.impl/iced_futures/executor/trait.Executor.js" data-ignore-extern-crates="iced_futures,tokio,futures_executor" async></script></section></div></main></body></html> |