Merge pull request #2588 from iced-rs/must-use-task

Add `must_use` attribute to `Task`
iced-rs · Sep 19, 2024 · 3a9139e · 3a9139e
2 parents bf3b6f1 + 114f7df
commit 3a9139e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/futures/src/subscription.rs b/futures/src/subscription.rs
@@ -113,7 +113,7 @@ pub type Hasher = rustc_hash::FxHasher;
 /// ```
 ///
 /// [`Future`]: std::future::Future
-#[must_use = "`Subscription` must be returned to runtime to take effect"]
+#[must_use = "`Subscription` must be returned to the runtime to take effect; normally in your `subscription` function."]
 pub struct Subscription<T> {
     recipes: Vec<Box<dyn Recipe<Output = T>>>,
 }

diff --git a/runtime/src/task.rs b/runtime/src/task.rs
@@ -14,6 +14,7 @@ use std::future::Future;
 ///
 /// A [`Task`] _may_ produce a bunch of values of type `T`.
 #[allow(missing_debug_implementations)]
+#[must_use = "`Task` must be returned to the runtime to take effect; normally in your `update` or `new` functions."]
 pub struct Task<T>(Option<BoxStream<Action<T>>>);
 
 impl<T> Task<T> {