add custom message type

README.md

@@ -136,15 +136,15 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     client
         .publish_message("hello world!")
         .channel("my_channel")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 
    // Send a message to another channel
     client
         .publish_message("hello world on the other channel!")
         .channel("my_channel_2")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 

examples/crypto.rs

@@ -65,7 +65,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
     let result = client
         .publish_message("hello world!")
         .channel("my_channel")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 

examples/custom_origin.rs

@@ -28,7 +28,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
     let result = client
         .publish_message("hello world!")
         .channel("my_channel")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 

examples/no_std/src/publish.rs

@@ -140,7 +140,7 @@ fn publish_example() -> Result<(), PubNubError> {
         .use_post(true)
         .ttl(10)
         .space_id("my_space")
-        .r#type("my_type")
+        .custom_message_type("my_type")
         .execute_blocking()?;
 
     Ok(())

examples/publish.rs

@@ -26,7 +26,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
     let result = client
         .publish_message("hello world!")
         .channel("my_channel")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 
@@ -37,7 +37,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
         client
             .publish_message("hello async world!")
             .channel("my_channel")
-            .r#type("text-message")
+            .custom_message_type("text-message")
             .execute(),
     );
 
@@ -48,7 +48,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
             description: "Check out this awesome playlist I made!".into(),
         })
         .channel("my_channel")
-        .r#type("url-with-description")
+        .custom_message_type("url-with-description")
         .execute()
         .await?;
 
@@ -64,7 +64,7 @@ async fn main() -> Result<(), Box<dyn snafu::Error>> {
         .use_post(true)
         .ttl(10)
         .space_id("my_space")
-        .r#type("text-message")
+        .custom_message_type("text-message")
         .execute()
         .await?;
 

examples/publish_blocking.rs

@@ -59,7 +59,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         .use_post(true)
         .ttl(10)
         .space_id("my_space")
-        .r#type("my_type")
+        .custom_message_type("my_type")
         .execute_blocking()?;
 
     println!("result: {:?}", result);

src/dx/publish/builders.rs

@@ -169,5 +169,5 @@ where
 
     /// Message type to publish.
     #[builder(setter(strip_option, into), default = "None")]
-    pub(super) r#type: Option<String>,
+    pub(super) custom_message_type: Option<String>,
 }

src/dx/publish/mod.rs

@@ -257,8 +257,11 @@ where
             query_params.insert("space-id".to_string(), space_id.clone());
         }
 
-        if let Some(r#type) = &self.r#type {
-            query_params.insert("type".to_string(), r#type.clone());
+        if let Some(custom_message_type) = &self.custom_message_type {
+            query_params.insert(
+                "custom_message_type".to_string(),
+                custom_message_type.clone(),
+            );
         }
 
         query_params.insert("seqn".to_string(), self.seqn.to_string());
@@ -351,7 +354,7 @@ where
                 replicate: value.replicate,
                 use_post: value.use_post,
                 space_id: value.space_id,
-                r#type: value.r#type,
+                custom_message_type: value.custom_message_type,
             },
         }
     }
@@ -386,7 +389,7 @@ struct PublishMessageParams<M> {
     use_post: bool,
     meta: Option<HashMap<String, String>>,
     space_id: Option<String>,
-    r#type: Option<String>,
+    custom_message_type: Option<String>,
 }
 
 fn bool_to_numeric(value: bool) -> String {
@@ -486,7 +489,7 @@ mod should {
             .ttl(50)
             .store(true)
             .space_id("space_id")
-            .r#type("message_type")
+            .custom_message_type("message_type")
             .meta(HashMap::from([("k".to_string(), "v".to_string())]))
             .prepare_context_with_request()
             .unwrap();
@@ -496,10 +499,13 @@ mod should {
                 ("norep".to_string(), "true".to_string()),
                 ("store".to_string(), "1".to_string()),
                 ("space-id".to_string(), "space_id".to_string()),
-                ("type".to_string(), "message_type".to_string()),
+                (
+                    "custom_message_type".to_string(),
+                    "message_type".to_string()
+                ),
                 ("meta".to_string(), "{\"k\":\"v\"}".to_string()),
                 ("ttl".to_string(), "50".to_string()),
-                ("seqn".to_string(), "1".to_string())
+                ("seqn".to_string(), "1".to_string()),
             ]),
             result.data.query_parameters
         );

src/dx/subscribe/event_dispatcher.rs

@@ -430,7 +430,7 @@ mod it_should {
                 channel: "test-channel".to_string(),
                 subscription: "test-channel".to_string(),
                 data: "Test message 1".to_string().into_bytes(),
-                r#type: None,
+                custom_message_type: None,
                 space_id: None,
                 decryption_error: None,
             }),
@@ -440,7 +440,7 @@ mod it_should {
                 channel: "test-channel".to_string(),
                 subscription: "test-channel".to_string(),
                 data: "Test signal 1".to_string().into_bytes(),
-                r#type: None,
+                custom_message_type: None,
                 space_id: None,
                 decryption_error: None,
             }),
@@ -459,7 +459,7 @@ mod it_should {
                 channel: "test-channel".to_string(),
                 subscription: "test-channel".to_string(),
                 data: "Test message 2".to_string().into_bytes(),
-                r#type: None,
+                custom_message_type: None,
                 space_id: None,
                 decryption_error: None,
             }),

src/dx/subscribe/event_engine/effects/emit_messages.rs

@@ -34,7 +34,7 @@ mod should {
             channel: "test".to_string(),
             subscription: "test-group".to_string(),
             data: vec![],
-            r#type: None,
+            custom_message_type: None,
             space_id: None,
             decryption_error: None,
         };

src/dx/subscribe/result.rs

@@ -209,7 +209,7 @@
     /// PubNub defined event type.
     #[cfg_attr(
         feature = "serde",
         serde(rename = "f"),
         serde(default = "Envelope::default_message_type")
     )]
     pub message_type: SubscribeMessageType,
@@ -257,11 +257,11 @@
     pub subscription: Option<String>,
 
     /// User provided message type (set only when [`publish`] called with
-    /// `r#type`).
+    /// `custom_message_type`).
     ///
     /// [`publish`]: crate::dx::publish
-    #[cfg_attr(feature = "serde", serde(rename = "mt"), serde(default))]
-    pub r#type: Option<String>,
+    #[cfg_attr(feature = "serde", serde(rename = "cmt"), serde(default))]
+    pub custom_message_type: Option<String>,
 
     /// Identifier of space into which message has been published (set only when
     /// [`publish`] called with `space_id`).

src/dx/subscribe/types.rs

@@ -470,10 +470,10 @@ pub struct Message {
     pub data: Vec<u8>,
 
     /// User provided message type (set only when [`publish`] called with
-    /// `r#type`).
+    /// `custom_message_type`).
     ///
     /// [`publish`]: crate::dx::publish
-    pub r#type: Option<String>,
+    pub custom_message_type: Option<String>,
 
     /// Identifier of space into which message has been published (set only when
     /// [`publish`] called with `space_id`).
@@ -1097,7 +1097,7 @@ impl TryFrom<Envelope> for Message {
                 channel: value.channel,
                 subscription,
                 data: value.payload.into(),
-                r#type: value.r#type,
+                custom_message_type: value.custom_message_type,
                 space_id: value.space_id,
                 decryption_error: None,
             })

src/lib.rs

@@ -139,15 +139,15 @@
 //!     client
 //!         .publish_message("hello world!")
 //!         .channel("my_channel")
-//!         .r#type("text-message")
+//!         .custom_message_type("text-message")
 //!         .execute()
 //!         .await?;
 //!
 //!    // Send a message to another channel
 //!     client
 //!         .publish_message("hello world on the other channel!")
 //!         .channel("my_channel_2")
-//!         .r#type("text-message")
+//!         .custom_message_type("text-message")
 //!         .execute()
 //!         .await?;
 //!