summaryrefslogtreecommitdiffstats
path: root/futures/src/runtime.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón <hector0193@gmail.com>2022-05-02 21:21:24 +0200
committerLibravatar GitHub <noreply@github.com>2022-05-02 21:21:24 +0200
commit5acba65c1135d8ebbda94efc74ea0bebb29c438a (patch)
tree88673403313ad90cec226ee92d4ebf4ef0a24bdc /futures/src/runtime.rs
parenta17a7103d382f02c64e7b271d953ea6babffac97 (diff)
parent7e111f273fb22a6ffc7a4fd24bea5e838d276758 (diff)
downloadiced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.gz
iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.bz2
iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.zip
Merge pull request #1327 from iced-rs/update-docs
Update documentation
Diffstat (limited to '')
-rw-r--r--futures/src/runtime.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/futures/src/runtime.rs b/futures/src/runtime.rs
index 2034ed6c..34f6b6dd 100644
--- a/futures/src/runtime.rs
+++ b/futures/src/runtime.rs
@@ -9,6 +9,8 @@ use std::marker::PhantomData;
///
/// If you have an [`Executor`], a [`Runtime`] can be leveraged to run any
/// [`Command`] or [`Subscription`] and get notified of the results!
+///
+/// [`Command`]: crate::Command
#[derive(Debug)]
pub struct Runtime<Hasher, Event, Executor, Sender, Message> {
executor: Executor,
@@ -51,10 +53,12 @@ where
self.executor.enter(f)
}
- /// Spawns a [`Command`] in the [`Runtime`].
+ /// Spawns a [`Future`] in the [`Runtime`].
///
/// The resulting `Message` will be forwarded to the `Sender` of the
/// [`Runtime`].
+ ///
+ /// [`Future`]: BoxFuture
pub fn spawn(&mut self, future: BoxFuture<Message>) {
use futures::{FutureExt, SinkExt};