Merge pull request #95 from slinkydeveloper/docs

Another round of docs fix + cleanups

Author: Lazzaretti

Cargo.toml

@@ -11,6 +11,7 @@ repository = "https://github.com/cloudevents/sdk-rust"
 exclude = [
     ".github/*"
 ]
+categories = ["web-programming", "encoding", "data-structures"]
 
 [lib]
 name = "cloudevents"
@@ -36,6 +37,7 @@ uuid = { version = "^0.8", features = ["v4", "wasm-bindgen"] }
 [dev-dependencies]
 rstest = "0.6"
 claim = "0.3.1"
+version-sync = "^0.9"
 
 [workspace]
 members = [

README.md

@@ -30,6 +30,7 @@ Note: This project is WIP under active development, hence all APIs are considere
 To get started, add the dependency to `Cargo.toml`:
 
 ```toml
+[dependencies]
 cloudevents-sdk = "0.2.0"
 ```
 
@@ -43,8 +44,7 @@ let event = EventBuilderV10::new()
     .id("aaa")
     .source(Url::parse("http://localhost").unwrap())
     .ty("example.demo")
-    .build()
-    .unwrap();
+    .build()?;
 ```
 
 Checkout the examples using our integrations to learn how to send and receive events:

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
 
@@ -23,4 +24,5 @@ futures = "^0.3"
 [dev-dependencies]
 url = { version = "^2.1", features = ["serde"] }
 serde_json = "^1.0"
-chrono = { version = "^0.4", features = ["serde"] }
+chrono = { version = "^0.4", features = ["serde"] }
+version-sync = "^0.9"

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,17 @@
 //!
 //! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
 
+#![doc(html_root_url = "https://docs.rs/cloudevents-sdk-actix-web/0.2.0")]
+#![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::*;

cloudevents-sdk-actix-web/tests/version_number.rs

@@ -0,0 +1,9 @@
+#[test]
+fn test_readme_deps() {
+    version_sync::assert_markdown_deps_updated!("README.md");
+}
+
+#[test]
+fn test_html_root_url() {
+    version_sync::assert_html_root_url_updated!("src/lib.rs");
+}

cloudevents-sdk-rdkafka/Cargo.toml

@@ -8,18 +8,20 @@ description = "CloudEvents official Rust SDK - Kafka integration"
 documentation = "https://docs.rs/cloudevents-sdk-rdkafka"
 repository = "https://github.com/cloudevents/sdk-rust"
 readme = "README.md"
+categories = ["web-programming", "encoding"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 bytes = "^0.5"
 cloudevents-sdk = { version = "0.2.0", path = ".." }
 lazy_static = "1.4.0"
-rdkafka = { version = "^0.24", features = ["cmake-build"] }
-
+rdkafka = { version = "^0.24", default-features = false }
 
 [dev-dependencies]
 url = { version = "^2.1" }
 serde_json = "^1.0"
 chrono = { version = "^0.4", features = ["serde"] }
 futures = "0.3.5"
+rdkafka = { version = "^0.24" }
+version-sync = "^0.9"

cloudevents-sdk-rdkafka/src/kafka_consumer_record.rs

@@ -134,8 +134,10 @@ pub fn record_to_event(msg: &impl Message) -> Result<Event> {
     MessageDeserializer::into_event(ConsumerRecordDeserializer::new(msg)?)
 }
 
-/// Extension Trait for [`Message`] which acts as a wrapper for the function [`record_to_event()`]
-pub trait MessageExt {
+/// Extension Trait for [`Message`] which acts as a wrapper for the function [`record_to_event()`].
+///
+/// This trait is sealed and cannot be implemented for types outside of this crate.
+pub trait MessageExt: private::Sealed {
     /// Generates [`Event`] from [`BorrowedMessage`].
     fn to_event(&self) -> Result<Event>;
 }
@@ -152,6 +154,13 @@ impl MessageExt for OwnedMessage {
     }
 }
 
+mod private {
+    // Sealing the MessageExt
+    pub trait Sealed {}
+    impl Sealed for rdkafka::message::OwnedMessage {}
+    impl Sealed for rdkafka::message::BorrowedMessage<'_> {}
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

cloudevents-sdk-rdkafka/src/kafka_producer_record.rs

@@ -88,7 +88,9 @@ impl StructuredSerializer<MessageRecord> for MessageRecord {
 }
 
 /// Extension Trait for [`BaseRecord`] that fills the record with a [`MessageRecord`].
-pub trait BaseRecordExt<'a, K: ToBytes + ?Sized> {
+///
+/// This trait is sealed and cannot be implemented for types outside of this crate.
+pub trait BaseRecordExt<'a, K: ToBytes + ?Sized>: private::Sealed {
     /// Fill this [`BaseRecord`] with a [`MessageRecord`].
     fn message_record(
         self,
@@ -112,7 +114,9 @@ impl<'a, K: ToBytes + ?Sized> BaseRecordExt<'a, K> for BaseRecord<'a, K, Vec<u8>
 }
 
 /// Extension Trait for [`FutureRecord`] that fills the record with a [`MessageRecord`].
-pub trait FutureRecordExt<'a, K: ToBytes + ?Sized> {
+///
+/// This trait is sealed and cannot be implemented for types outside of this crate.
+pub trait FutureRecordExt<'a, K: ToBytes + ?Sized>: private::Sealed {
     /// Fill this [`FutureRecord`] with a [`MessageRecord`].
     fn message_record(self, message_record: &'a MessageRecord) -> FutureRecord<'a, K, Vec<u8>>;
 }
@@ -128,3 +132,16 @@ impl<'a, K: ToBytes + ?Sized> FutureRecordExt<'a, K> for FutureRecord<'a, K, Vec
         self
     }
 }
+
+mod private {
+    // Sealing the FutureRecordExt and BaseRecordExt
+    pub trait Sealed {}
+    impl<K: rdkafka::message::ToBytes + ?Sized, V: rdkafka::message::ToBytes> Sealed
+        for rdkafka::producer::FutureRecord<'_, K, V>
+    {
+    }
+    impl<K: rdkafka::message::ToBytes + ?Sized, V: rdkafka::message::ToBytes> Sealed
+        for rdkafka::producer::BaseRecord<'_, K, V>
+    {
+    }
+}