diff options
author | 2019-12-14 05:56:46 +0100 | |
---|---|---|
committer | 2019-12-14 05:56:46 +0100 | |
commit | d6c3da21f7fe7a79bcfbc2a180dc111e42300a04 (patch) | |
tree | bbe8e02712824cd0fe22028bd3072fbfce104d62 /src | |
parent | 293314405f5b8d4003db5ef8f428e659ae36872d (diff) | |
download | iced-d6c3da21f7fe7a79bcfbc2a180dc111e42300a04.tar.gz iced-d6c3da21f7fe7a79bcfbc2a180dc111e42300a04.tar.bz2 iced-d6c3da21f7fe7a79bcfbc2a180dc111e42300a04.zip |
Write docs for subscriptions and reorganize a bit
Diffstat (limited to 'src')
-rw-r--r-- | src/application.rs | 17 | ||||
-rw-r--r-- | src/sandbox.rs | 2 |
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() } |