Merge pull request #1019 from hecrj/command-actions

Platform-specific `Command` implementations

2 files changed, 118 insertions, 0 deletions

diff --git a/native/src/command.rs b/native/src/command.rs
new file mode 100644
index 00000000..6fe518d7
--- /dev/null
+++ b/native/src/command.rs
@@ -0,0 +1,72 @@
+//! Run asynchronous actions.
+mod action;
+
+pub use action::Action;
+
+use std::fmt;
+use std::future::Future;
+
+/// A set of asynchronous actions to be performed by some runtime.
+pub struct Command<T>(iced_futures::Command<Action<T>>);
+
+impl<T> Command<T> {
+    /// Creates an empty [`Command`].
+    ///
+    /// In other words, a [`Command`] that does nothing.
+    pub const fn none() -> Self {
+        Self(iced_futures::Command::none())
+    }
+
+    /// Creates a [`Command`] that performs a single [`Action`].
+    pub const fn single(action: Action<T>) -> Self {
+        Self(iced_futures::Command::single(action))
+    }
+
+    /// Creates a [`Command`] that performs the action of the given future.
+    pub fn perform<A>(
+        future: impl Future<Output = T> + 'static + Send,
+        f: impl Fn(T) -> A + 'static + Send,
+    ) -> Command<A> {
+        use iced_futures::futures::FutureExt;
+
+        Command::single(Action::Future(Box::pin(future.map(f))))
+    }
+
+    /// Creates a [`Command`] that performs the actions of all the given
+    /// commands.
+    ///
+    /// Once this command is run, all the commands will be executed at once.
+    pub fn batch(commands: impl IntoIterator<Item = Command<T>>) -> Self {
+        Self(iced_futures::Command::batch(
+            commands.into_iter().map(|Command(command)| command),
+        ))
+    }
+
+    /// Applies a transformation to the result of a [`Command`].
+    pub fn map<A>(
+        self,
+        f: impl Fn(T) -> A + 'static + Send + Sync + Clone,
+    ) -> Command<A>
+    where
+        T: 'static,
+    {
+        let Command(command) = self;
+
+        Command(command.map(move |action| action.map(f.clone())))
+    }
+
+    /// Returns all of the actions of the [`Command`].
+    pub fn actions(self) -> Vec<Action<T>> {
+        let Command(command) = self;
+
+        command.actions()
+    }
+}
+
+impl<T> fmt::Debug for Command<T> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let Command(command) = self;
+
+        command.fmt(f)
+    }
+}
diff --git a/native/src/command/action.rs b/native/src/command/action.rs
new file mode 100644
index 00000000..77be1b59
--- /dev/null
+++ b/native/src/command/action.rs
@@ -0,0 +1,46 @@
+use crate::clipboard;
+use crate::window;
+
+use std::fmt;
+
+/// An action that a [`Command`] can perform.
+///
+/// [`Command`]: crate::Command
+pub enum Action<T> {
+    /// Run a [`Future`] to completion.
+    Future(iced_futures::BoxFuture<T>),
+
+    /// Run a clipboard action.
+    Clipboard(clipboard::Action<T>),
+
+    /// Run a window action.
+    Window(window::Action),
+}
+
+impl<T> Action<T> {
+    /// Applies a transformation to the result of a [`Command`].
+    pub fn map<A>(self, f: impl Fn(T) -> A + 'static + Send + Sync) -> Action<A>
+    where
+        T: 'static,
+    {
+        use iced_futures::futures::FutureExt;
+
+        match self {
+            Self::Future(future) => Action::Future(Box::pin(future.map(f))),
+            Self::Clipboard(action) => Action::Clipboard(action.map(f)),
+            Self::Window(window) => Action::Window(window),
+        }
+    }
+}
+
+impl<T> fmt::Debug for Action<T> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::Future(_) => write!(f, "Action::Future"),
+            Self::Clipboard(action) => {
+                write!(f, "Action::Clipboard({:?})", action)
+            }
+            Self::Window(action) => write!(f, "Action::Window({:?})", action),
+        }
+    }
+}