Docs in cloudevents-sdk-actix-web

Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>

Author: slinkydeveloper

cloudevents-sdk-actix-web/Cargo.toml

@@ -8,6 +8,7 @@ description = "CloudEvents official Rust SDK - Actix-Web integration"
 documentation = "https://docs.rs/cloudevents-sdk-actix-web"
 repository = "https://github.com/cloudevents/sdk-rust"
 readme = "README.md"
+categories = ["web-programming", "encoding", "web-programming::http-server"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

cloudevents-sdk-actix-web/src/lib.rs

@@ -3,7 +3,7 @@
 //! To deserialize an HTTP request as CloudEvent:
 //!
 //! ```
-//! use cloudevents_sdk_actix_web::RequestExt;
+//! use cloudevents_sdk_actix_web::HttpRequestExt;
 //! use actix_web::{HttpRequest, web, post};
 //!
 //! #[post("/")]
@@ -41,14 +41,16 @@
 //!
 //! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
 
+#![deny(broken_intra_doc_links)]
+
 #[macro_use]
 mod headers;
 mod server_request;
 mod server_response;
 
 pub use server_request::request_to_event;
 pub use server_request::HttpRequestDeserializer;
-pub use server_request::RequestExt;
+pub use server_request::HttpRequestExt;
 pub use server_response::event_to_response;
 pub use server_response::HttpResponseBuilderExt;
 pub use server_response::HttpResponseSerializer;

cloudevents-sdk-actix-web/src/server_request.rs

@@ -113,16 +113,19 @@ pub async fn request_to_event(
 }
 
 /// Extention Trait for [`HttpRequest`] which acts as a wrapper for the function [`request_to_event()`].
+///
+/// This trait is sealed and cannot be implemented for types outside of this crate.
 #[async_trait(?Send)]
-pub trait RequestExt {
+pub trait HttpRequestExt: private::Sealed {
+    /// Convert this [`HttpRequest`] into an [`Event`].
     async fn to_event(
         &self,
         mut payload: web::Payload,
     ) -> std::result::Result<Event, actix_web::error::Error>;
 }
 
 #[async_trait(?Send)]
-impl RequestExt for HttpRequest {
+impl HttpRequestExt for HttpRequest {
     async fn to_event(
         &self,
         payload: web::Payload,
@@ -131,6 +134,12 @@ impl RequestExt for HttpRequest {
     }
 }
 
+mod private {
+    // Sealing the RequestExt
+    pub trait Sealed {}
+    impl Sealed for actix_web::HttpRequest {}
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

cloudevents-sdk-actix-web/src/server_response.rs

@@ -76,9 +76,12 @@ pub async fn event_to_response(
         .map_err(actix_web::error::ErrorBadRequest)
 }
 
-/// Extention Trait for [`HttpResponseBuilder`] which acts as a wrapper for the function [`event_to_response()`].
+/// Extension Trait for [`HttpResponseBuilder`] which acts as a wrapper for the function [`event_to_response()`].
+///
+/// This trait is sealed and cannot be implemented for types outside of this crate.
 #[async_trait(?Send)]
-pub trait HttpResponseBuilderExt {
+pub trait HttpResponseBuilderExt: private::Sealed {
+    /// Fill this [`HttpResponseBuilder`] with an [`Event`].
     async fn event(
         self,
         event: Event,
@@ -95,6 +98,12 @@ impl HttpResponseBuilderExt for HttpResponseBuilder {
     }
 }
 
+// Sealing the HttpResponseBuilderExt
+mod private {
+    pub trait Sealed {}
+    impl Sealed for actix_web::dev::HttpResponseBuilder {}
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;