Struct iced::Subscription

pub struct Subscription<Message> { /* private fields */ }

A request to listen to external events.

Besides performing async actions on demand with Command, most applications also need to listen to external events passively.

A Subscription is normally provided to some runtime, like a Command, and it will generate events as long as the user keeps requesting it.

For instance, you can use a Subscription to listen to a WebSocket connection, keyboard presses, mouse events, time ticks, etc.

Implementations

impl<Message> Subscription<Message>

pub fn none() -> Subscription<Message>

Returns an empty Subscription that will not produce any output.

pub fn from_recipe( recipe: impl Recipe<Output = Message> + 'static ) -> Subscription<Message>

Creates a Subscription from a Recipe describing it.

pub fn batch( subscriptions: impl IntoIterator<Item = Subscription<Message>> ) -> Subscription<Message>

Batches all the provided subscriptions and returns the resulting Subscription.

pub fn into_recipes( self ) -> Vec<Box<dyn Recipe<Output = Message> + 'static, Global>, Global>

Returns the different recipes of the Subscription.

pub fn with<T>(self, value: T) -> Subscription<(T, Message)>where Message: 'static, T: Hash + Clone + Send + Sync + 'static,

Adds a value to the Subscription context.

The value will be part of the identity of a Subscription.

pub fn map<A>(self, f: fn(_: Message) -> A) -> Subscription<A>where Message: 'static, A: 'static,

Transforms the Subscription output with the given function.

Trait Implementations

impl<Message> Debug for Subscription<Message>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.