Add DebugResult

Author: AntoniosBarotsis

src/api_keys.rs

@@ -200,13 +200,13 @@ pub mod types {
 #[cfg(test)]
 #[allow(clippy::needless_return)]
 mod test {
+    use crate::test::DebugResult;
     use crate::tests::CLIENT;
     use crate::types::CreateApiKeyOptions;
-    use crate::Result;
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn all() -> Result<()> {
+    async fn all() -> DebugResult<()> {
         let resend = &*CLIENT;
 
         let api_key = "test_";

src/audiences.rs

@@ -168,12 +168,12 @@ pub mod types {
 #[cfg(test)]
 #[allow(clippy::needless_return)]
 mod test {
+    use crate::test::DebugResult;
     use crate::tests::CLIENT;
-    use crate::Result;
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn all() -> Result<()> {
+    async fn all() -> DebugResult<()> {
         let resend = &*CLIENT;
         let audience = "test_audiences";
 

src/broadcasts.rs

@@ -366,16 +366,16 @@ pub mod types {
 #[allow(clippy::needless_return)]
 mod test {
     use crate::{
+        test::DebugResult,
         tests::CLIENT,
         types::{CreateBroadcastOptions, SendBroadcastOptions, UpdateBroadcastOptions},
-        Result,
     };
 
     use super::types::Broadcast;
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn create_send_broadcast() -> Result<()> {
+    async fn create_send_broadcast() -> DebugResult<()> {
         let resend = &*CLIENT;
         std::thread::sleep(std::time::Duration::from_secs(1));
 
@@ -410,7 +410,7 @@ mod test {
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn list_get_broadcast() -> Result<()> {
+    async fn list_get_broadcast() -> DebugResult<()> {
         let resend = &*CLIENT;
         std::thread::sleep(std::time::Duration::from_secs(1));
 
@@ -444,7 +444,8 @@ mod test {
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn update_broadcast() -> Result<()> {
+    #[track_caller]
+    async fn update_broadcast() -> DebugResult<()> {
         let resend = &*CLIENT;
         std::thread::sleep(std::time::Duration::from_secs(1));
 

src/contacts.rs

@@ -345,13 +345,13 @@ pub mod types {
 #[cfg(test)]
 #[allow(clippy::needless_return)]
 mod test {
+    use crate::test::DebugResult;
     use crate::tests::CLIENT;
     use crate::types::{ContactChanges, ContactData};
-    use crate::Result;
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn all() -> Result<()> {
+    async fn all() -> DebugResult<()> {
         let resend = &*CLIENT;
         let audience = "test_contacts";
 

src/domains.rs

@@ -392,13 +392,13 @@ pub mod types {
 mod test {
     use crate::{
         domains::types::{CreateDomainOptions, DomainChanges, Tls},
+        test::DebugResult,
         tests::CLIENT,
-        Result,
     };
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
-    async fn all() -> Result<()> {
+    async fn all() -> DebugResult<()> {
         let resend = &*CLIENT;
 
         // Create

src/emails.rs

@@ -482,13 +482,13 @@ where
 #[allow(clippy::needless_return)]
 mod test {
     use crate::types::{CreateEmailBaseOptions, Email, Tag, UpdateEmailOptions};
-    use crate::{tests::CLIENT, Result};
+    use crate::{test::DebugResult, tests::CLIENT};
     use jiff::{Span, Timestamp, Zoned};
 
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
     // #[ignore]
-    async fn all() -> Result<()> {
+    async fn all() -> DebugResult<()> {
         let from = "Acme <[email protected]>";
         let to = ["[email protected]"];
         let subject = "Hello World!";
@@ -568,7 +568,7 @@ mod test {
     #[test]
     // #[ignore]
     #[cfg(feature = "blocking")]
-    fn all_blocking() -> Result<()> {
+    fn all_blocking() -> DebugResult<()> {
         let from = "Acme <[email protected]>";
         let to = ["[email protected]"];
         let subject = "Hello World!";
@@ -588,7 +588,7 @@ mod test {
     #[tokio_shared_rt::test(shared = true)]
     #[cfg(not(feature = "blocking"))]
     // #[ignore]
-    async fn schedule_email() -> Result<()> {
+    async fn schedule_email() -> DebugResult<()> {
         let now_plus_1h = Zoned::now()
             .checked_add(Span::new().hours(1))
             .expect("Valid date")

src/lib.rs

@@ -2,10 +2,10 @@
 #![doc = include_str!("../README.md")]
 //! ### Rate Limits
 //!
-//! Resend implements rate limitting on their API which can sometimes get in the way of whatever
+//! Resend implements rate limiting on their API which can sometimes get in the way of whatever
 //! you are trying to do. This crate handles that in 2 ways:
 //!
-//! - Firstly *all* requests made by the [`Resend`] client are automatically rate limitted to
+//! - Firstly *all* requests made by the [`Resend`] client are automatically rate limited to
 //!   9 req/1.1s to avoid collisions with the 10 req/s limit that Resend imposes at the time of
 //!   writing this.
 //!
@@ -85,6 +85,11 @@ pub mod types {
     };
     pub use super::audiences::types::{Audience, AudienceId, CreateAudienceResponse};
     pub use super::batch::BatchSvc;
+    pub use super::broadcasts::types::{
+        Broadcast, BroadcastId, CreateBroadcastOptions, CreateBroadcastResponse,
+        RemoveBroadcastResponse, SendBroadcastOptions, SendBroadcastResponse,
+        UpdateBroadcastOptions, UpdateBroadcastResponse,
+    };
     pub use super::contacts::types::{Contact, ContactChanges, ContactData, ContactId};
     pub use super::domains::types::{
         CreateDomainOptions, DkimRecordType, Domain, DomainChanges, DomainDkimRecord, DomainId,
@@ -95,12 +100,6 @@ pub mod types {
         Attachment, CancelScheduleResponse, ContentOrPath, CreateEmailBaseOptions,
         CreateEmailResponse, Email, EmailId, Tag, UpdateEmailOptions, UpdateEmailResponse,
     };
-    // TODO: Add broadcasts here
-    pub use super::broadcasts::types::{
-        Broadcast, BroadcastId, CreateBroadcastOptions, CreateBroadcastResponse,
-        RemoveBroadcastResponse, SendBroadcastOptions, SendBroadcastResponse,
-        UpdateBroadcastOptions, UpdateBroadcastResponse,
-    };
     pub use super::error::types::{ErrorKind, ErrorResponse};
 }
 
@@ -131,6 +130,30 @@ pub enum Error {
     },
 }
 
+#[cfg(test)]
+mod test {
+    use crate::Error;
+
+    #[derive(Debug)]
+    #[allow(dead_code)]
+    pub struct LocatedError<E: std::error::Error + 'static> {
+        inner: E,
+        location: &'static std::panic::Location<'static>,
+    }
+
+    impl From<Error> for LocatedError<Error> {
+        #[track_caller]
+        fn from(value: Error) -> Self {
+            Self {
+                inner: value,
+                location: std::panic::Location::caller(),
+            }
+        }
+    }
+
+    pub type DebugResult<T, E = LocatedError<Error>> = Result<T, E>;
+}
+
 /// Specialized [`Result`] type for an [`Error`].
 ///
 /// [`Result`]: std::result::Result