summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/application.rs17
-rw-r--r--src/sandbox.rs2
2 files changed, 14 insertions, 5 deletions
diff --git a/src/application.rs b/src/application.rs
index 95113344..98e160ce 100644
--- a/src/application.rs
+++ b/src/application.rs
@@ -117,8 +117,17 @@ pub trait Application: Sized {
/// [`Command`]: struct.Command.html
fn update(&mut self, message: Self::Message) -> Command<Self::Message>;
- /// TODO
- fn subscriptions(&self) -> Subscription<Self::Message> {
+ /// Returns the event [`Subscription`] for the current state of the
+ /// application.
+ ///
+ /// A [`Subscription`] will be kept alive as long as you keep returning it,
+ /// and the __messages__ produced will be handled by
+ /// [`update`](#tymethod.update).
+ ///
+ /// By default, this method returns an empty [`Subscription`].
+ ///
+ /// [`Subscription`]: struct.Subscription.html
+ fn subscription(&self) -> Subscription<Self::Message> {
Subscription::none()
}
@@ -173,8 +182,8 @@ where
self.0.update(message)
}
- fn subscriptions(&self) -> Subscription<Self::Message> {
- self.0.subscriptions()
+ fn subscription(&self) -> Subscription<Self::Message> {
+ self.0.subscription()
}
fn view(&mut self) -> Element<'_, Self::Message> {
diff --git a/src/sandbox.rs b/src/sandbox.rs
index 248aa152..75020b16 100644
--- a/src/sandbox.rs
+++ b/src/sandbox.rs
@@ -149,7 +149,7 @@ where
Command::none()
}
- fn subscriptions(&self) -> Subscription<T::Message> {
+ fn subscription(&self) -> Subscription<T::Message> {
Subscription::none()
}