libcosmic/src/task.rs

// Copyright 2023 System76 <info@system76.com>
// SPDX-License-Identifier: MPL-2.0

//! Create asynchronous actions to be performed in the background.

use futures::stream::{Stream, StreamExt};
use std::future::Future;

/// Yields a task which contains a batch of tasks.
pub fn batch<X: Send + 'static + Into<Y>, Y: Send + 'static>(
    tasks: impl IntoIterator<Item = iced::Task<X>>,
) -> iced::Task<Y> {
    iced::Task::batch(tasks).map(Into::into)
}

/// Yields a task which will run the future on the runtime executor.
pub fn future<X: Into<Y>, Y: 'static>(
    future: impl Future<Output = X> + Send + 'static,
) -> iced::Task<Y> {
    iced::Task::future(async move { future.await.into() })
}

/// Yields a task which will return a message.
pub fn message<X: Send + 'static + Into<Y>, Y: 'static>(message: X) -> iced::Task<Y> {
    future(async move { message.into() })
}

/// Yields a task which will run a stream on the runtime executor.
pub fn stream<X: Into<Y> + 'static, Y: 'static>(
    stream: impl Stream<Item = X> + Send + 'static,
) -> iced::Task<Y> {
    iced::Task::stream(stream.map(Into::into))
}

pub fn none<Y: 'static>() -> iced::Task<Y> {
    iced::Task::none()
}