Trait iced::subscription::Recipe

source ·
pub trait Recipe<Hasher, Event>where
    Hasher: Hasher,{
    type Output;

    // Required methods
    fn hash(&self, state: &mut Hasher);
    fn stream(
        self: Box<Self, Global>,
        input: Pin<Box<dyn Stream<Item = Event> + Send + 'static, Global>>
    ) -> Pin<Box<dyn Stream<Item = Self::Output> + Send + 'static, Global>>;
}
Expand description

The description of a Subscription.

A Recipe is the internal definition of a Subscription. It is used by runtimes to run and identify subscriptions. You can use it to create your own!

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.

Required Associated Types§

source

type Output

The events that will be produced by a Subscription with this Recipe.

Required Methods§

source

fn hash(&self, state: &mut Hasher)

Hashes the Recipe.

This is used by runtimes to uniquely identify a Subscription.

source

fn stream( self: Box<Self, Global>, input: Pin<Box<dyn Stream<Item = Event> + Send + 'static, Global>> ) -> Pin<Box<dyn Stream<Item = Self::Output> + Send + 'static, Global>>

Executes the Recipe and produces the stream of events of its Subscription.

It receives some stream of generic events, which is normally defined by shells.

Implementors§