feat: better error handling (#29)

Author: AtifChy

.gitignore

@@ -1,3 +1,4 @@
 /target/
 **/*.rs.bk
 Cargo.lock
+/.idea

Cargo.toml

@@ -19,6 +19,7 @@ default-target = "x86_64-pc-windows-msvc"
 
 [dependencies]
 quick-xml = "0.31"
+thiserror = "1.0"
 windows-version = "0.1"
 
   [dependencies.windows]

examples/simple.rs

@@ -13,7 +13,7 @@ fn main() {
         .text1("(╯°□°）╯︵ ┻━┻")
         .sound(Some(Sound::SMS))
         .duration(Duration::Short)
-        .on_activated(move |action| -> windows::core::Result<()> {
+        .on_activated(move |action| {
             match action {
                 Some(action) => println!("You've clicked {}!", action),
                 None => println!("You've clicked me!"),

src/lib.rs

@@ -45,9 +45,21 @@ use std::fmt::Write;
 use std::path::Path;
 use std::str::FromStr;
 
-pub use windows::core::{Error, Result, HSTRING};
+pub use windows::core::HSTRING;
 pub use windows::UI::Notifications::ToastNotification;
 
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error("Windows API error: {0}")]
+    Os(#[from] windows::core::Error),
+    #[error("IO error: {0}")]
+    Io(#[from] std::io::Error),
+}
+
+pub type Result<T> = std::result::Result<T, Error>;
+
 /// `ToastDismissalReason` is a struct representing the reason a toast notification was dismissed.
 ///
 /// Variants:
@@ -255,7 +267,7 @@ pub enum Scenario {
     Default,
     /// This will be displayed pre-expanded and stay on the user's screen till dismissed. Audio will loop by default and will use alarm audio.
     Alarm,
-    /// This will be displayed pre-expanded and stay on the user's screen till dismissed..
+    /// This will be displayed pre-expanded and stay on the user's screen till dismissed.
     Reminder,
     /// This will be displayed pre-expanded in a special call format and stay on the user's screen till dismissed. Audio will loop by default and will use ringtone audio.
     IncomingCall,
@@ -264,7 +276,7 @@ pub enum Scenario {
 impl Toast {
     /// This can be used if you do not have a AppUserModelID.
     ///
-    /// However, the toast will erroniously report its origin as powershell.
+    /// However, the toast will erroneously report its origin as powershell.
     pub const POWERSHELL_APP_ID: &'static str = "{1AC14E77-02E7-4E5D-B744-2EB1AE5198B7}\
                                                  \\WindowsPowerShell\\v1.0\\powershell.exe";
     /// Constructor for the toast builder.
@@ -372,7 +384,7 @@ impl Toast {
             );
             self
         } else {
-            // Win81 rejects the above xml so we fallback to a simpler call
+            // Win81 rejects the above xml, so we fall back to a simpler call
             self.image(source, alt_text)
         }
     }
@@ -390,7 +402,7 @@ impl Toast {
             );
             self
         } else {
-            // win81 rejects the above xml so we fallback to a simpler call
+            // win81 rejects the above xml, so we fall back to a simpler call
             self.image(source, alt_text)
         }
     }
@@ -436,7 +448,7 @@ impl Toast {
 
     /// Adds a button to the notification
     /// `content` is the text of the button.
-    /// `action` will be send as an argument [on_activated](Self::on_activated) when the button is clicked.
+    /// `action` will be sent as an argument [on_activated](Self::on_activated) when the button is clicked.
     pub fn add_button(mut self, content: &str, action: &str) -> Toast {
         self.buttons.push(Button {
             content: content.to_owned(),
@@ -447,12 +459,13 @@ impl Toast {
 
     // HACK: f is static so that we know the function is valid to call.
     //       this would be nice to remove at some point
-    pub fn on_activated<F: FnMut(Option<String>) -> Result<()> + Send + 'static>(
-        mut self,
-        mut f: F,
-    ) -> Self {
+    pub fn on_activated<F>(mut self, mut f: F) -> Self
+    where
+        F: FnMut(Option<String>) -> Result<()> + Send + 'static,
+    {
         self.on_activated = Some(TypedEventHandler::new(move |_, insp| {
-            f(Self::get_activated_action(insp))
+            let _ = f(Self::get_activated_action(insp));
+            Ok(())
         }));
         self
     }
@@ -492,12 +505,13 @@ impl Toast {
     ///     Ok(())
     /// }).show().expect("notification failed");
     /// ```
-    pub fn on_dismissed<F: Fn(Option<ToastDismissalReason>) -> Result<()> + Send + 'static>(
-        mut self,
-        f: F,
-    ) -> Self {
+    pub fn on_dismissed<F>(mut self, f: F) -> Self
+    where
+        F: Fn(Option<ToastDismissalReason>) -> Result<()> + Send + 'static,
+    {
         self.on_dismissed = Some(TypedEventHandler::new(move |_, args| {
-            f(Self::get_dismissed_reason(args))
+            let _ = f(Self::get_dismissed_reason(args));
+            Ok(())
         }));
         self
     }
@@ -513,7 +527,7 @@ impl Toast {
         None
     }
 
-    fn create_template(&self) -> windows::core::Result<ToastNotification> {
+    fn create_template(&self) -> Result<ToastNotification> {
         //using this to get an instance of XmlDocument
         let toast_xml = XmlDocument::new()?;
 
@@ -542,16 +556,16 @@ impl Toast {
         }
 
         toast_xml.LoadXml(&HSTRING::from(format!(
-            "<toast {} {}>
-                    <visual>
-                        <binding template=\"{}\">
+            r#"<toast {} {}>
+                <visual>
+                    <binding template="{}">
                         {}
                         {}{}{}
-                        </binding>
-                    </visual>
-                    {}
-                    {}
-                </toast>",
+                    </binding>
+                </visual>
+                {}
+                {}
+            </toast>"#,
             self.duration,
             self.scenario,
             template_binding,
@@ -564,11 +578,11 @@ impl Toast {
         )))?;
 
         // Create the toast
-        ToastNotification::CreateToastNotification(&toast_xml)
+        ToastNotification::CreateToastNotification(&toast_xml).map_err(Into::into)
     }
 
     /// Display the toast on the screen
-    pub fn show(&self) -> windows::core::Result<()> {
+    pub fn show(&self) -> Result<()> {
         let toast_template = self.create_template()?;
         if let Some(handler) = &self.on_activated {
             toast_template.Activated(handler)?;
@@ -582,7 +596,7 @@ impl Toast {
             ToastNotificationManager::CreateToastNotifierWithId(&HSTRING::from(&self.app_id))?;
 
         // Show the toast.
-        let result = toast_notifier.Show(&toast_template);
+        let result = toast_notifier.Show(&toast_template).map_err(Into::into);
         std::thread::sleep(std::time::Duration::from_millis(10));
         result
     }