diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-04-02 03:00:48 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-04-02 03:44:14 +0200 |
| commit | e1e42f87bdccb21c8c27e88063abd87bbdd22832 (patch) | |
| tree | c46ca183164e9dcae51e7c246fdb19ebfa16e736 /futures/src | |
| parent | 48b90a752915557f216bcbc808f4163a4d110dac (diff) | |
| download | iced-e1e42f87bdccb21c8c27e88063abd87bbdd22832.tar.gz iced-e1e42f87bdccb21c8c27e88063abd87bbdd22832.tar.bz2 iced-e1e42f87bdccb21c8c27e88063abd87bbdd22832.zip | |
Add examples to `subscription::Recipe` docs
Diffstat (limited to 'futures/src')
| -rw-r--r-- | futures/src/subscription.rs | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/futures/src/subscription.rs b/futures/src/subscription.rs index ab333a20..7a75fc31 100644 --- a/futures/src/subscription.rs +++ b/futures/src/subscription.rs @@ -142,6 +142,18 @@ impl<I, O, H> std::fmt::Debug for Subscription<I, O, H> { /// /// [`Subscription`]: struct.Subscription.html /// [`Recipe`]: trait.Recipe.html +/// +/// # Examples +/// The repository has a couple of [examples] that use a custom [`Recipe`]: +/// +/// - [`download_progress`], a basic application that asynchronously downloads +/// a dummy file of 100 MB and tracks the download progress. +/// - [`stopwatch`], a watch with start/stop and reset buttons showcasing how +/// to listen to time. +/// +/// [examples]: https://github.com/hecrj/iced/tree/0.1/examples +/// [`download_progress`]: https://github.com/hecrj/iced/tree/0.1/examples/download_progress +/// [`stopwatch`]: https://github.com/hecrj/iced/tree/0.1/examples/stopwatch pub trait Recipe<Hasher: std::hash::Hasher, Event> { /// The events that will be produced by a [`Subscription`] with this /// [`Recipe`]. |