From 2c630809d403f7fa87c3230be031299e5fb3af17 Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Mon, 13 Sep 2021 11:20:54 +0700
Subject: Write missing docs and `Debug` implementations for `native`

---
 native/src/clipboard.rs | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'native/src/clipboard.rs')

diff --git a/native/src/clipboard.rs b/native/src/clipboard.rs
index 4d59d960..60703c31 100644
--- a/native/src/clipboard.rs
+++ b/native/src/clipboard.rs
@@ -1,4 +1,5 @@
 //! Access the clipboard.
+use std::fmt;
 
 /// A buffer for short-term storage and transfer within and between
 /// applications.
@@ -22,12 +23,19 @@ impl Clipboard for Null {
     fn write(&mut self, _contents: String) {}
 }
 
+/// A clipboard action to be performed by some [`Command`].
+///
+/// [`Command`]: crate::Command
 pub enum Action<T> {
+    /// Read the clipboard and produce `T` with the result.
     Read(Box<dyn Fn(Option<String>) -> T>),
+
+    /// Write the given contents to the clipboard.
     Write(String),
 }
 
 impl<T> Action<T> {
+    /// Maps the output of a clipboard [`Action`] using the provided closure.
     pub fn map<A>(self, f: impl Fn(T) -> A + 'static + Send + Sync) -> Action<A>
     where
         T: 'static,
@@ -38,3 +46,12 @@ impl<T> Action<T> {
         }
     }
 }
+
+impl<T> fmt::Debug for Action<T> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::Read(_) => write!(f, "Action::Read"),
+            Self::Write(_) => write!(f, "Action::Write"),
+        }
+    }
+}
-- 
cgit