fix a few clippy errors

Signed-off-by: Lance-Drane <[email protected]>

Author: Lance-Drane

proxy-http-server/src/routes/publish.rs

@@ -58,7 +58,7 @@ pub async fn publish_message(
         .publish_message(&topic, data)
         .await
     {
-        Ok(_) => Ok((StatusCode::CREATED, "Success".to_string())),
+        Ok(()) => Ok((StatusCode::CREATED, "Success".to_string())),
         Err(_) => Err((
             StatusCode::INTERNAL_SERVER_ERROR,
             "server fault, message not published".to_string(),

shared-deps/src/protocols/amqp/init.rs

@@ -8,6 +8,9 @@ use crate::{
 };
 
 /// Sets up the AMQP proto handlers, and verifies that we can connect to the AMQP broker.
+///
+/// # Errors
+///   - If we can't make an initial connection to the broker, return Err.
 pub async fn init_amqp_proto_handlers(
     broker_config: &BrokerSettings,
     application_name: &'static str,

shared-deps/src/protocols/amqp/publish.rs

@@ -10,7 +10,7 @@ use crate::{
 #[derive(Clone)]
 pub struct AmqpPublishProtoHandler {
     pool: Pool,
-    /// application_name is used for the hardcoded queue name and for debugging purposes
+    /// `application_name` is used for the hardcoded queue name and for debugging purposes
     application_name: &'static str,
 }
 
@@ -23,6 +23,7 @@ impl std::fmt::Debug for AmqpPublishProtoHandler {
 }
 
 impl AmqpPublishProtoHandler {
+    #[must_use]
     pub fn new(pool: Pool, application_name: &'static str) -> Self {
         Self {
             pool,

shared-deps/src/protocols/amqp/subscribe.rs

@@ -14,7 +14,7 @@ use crate::protocols::interfaces::{HttpBroadcast, SubscribeProtoHandler};
 
 pub struct AmqpSubscribeProtoHandler {
     pool: Pool,
-    /// application_name is used for the hardcoded queue name and for debugging purposes
+    /// `application_name` is used for the hardcoded queue name and for debugging purposes
     application_name: &'static str,
 }
 
@@ -27,6 +27,7 @@ impl std::fmt::Debug for AmqpSubscribeProtoHandler {
 }
 
 impl AmqpSubscribeProtoHandler {
+    #[must_use]
     pub fn new(pool: Pool, application_name: &'static str) -> Self {
         Self {
             pool,

shared-deps/src/protocols/interfaces.rs

@@ -13,9 +13,12 @@ pub trait HttpBroadcast {
 }
 
 /// Trait which determines how to publish a message. Should usually show up as a reaction to receiving an HTTP event or request.
-/// Note that whatever implements PublishProtoHandler should generally implement Clone as well.
+/// Note that whatever implements `PublishProtoHandler` should generally implement Clone as well.
 pub trait PublishProtoHandler {
     /// this is meant to verify errors in the message before publishing
+    ///
+    /// # Errors
+    ///   - return an error message if message verification failed.
     fn preverify_publish(&self, topic: &str) -> Result<(), String>;
     /// the assumption is that once this function is called, all faults lie in the broker (and not the parameters)
     fn publish_message(
@@ -27,8 +30,8 @@ pub trait PublishProtoHandler {
 
 /// Trait which determines how to subscribe to a message. Usually runs in its own thread and uses an [`HttpBroadcast`] to send the message over an HTTP channel.
 pub trait SubscribeProtoHandler {
-    /// this should start a subscribe loop in a tokio::spawn thread, and return the JoinHandle.
-    /// this consumes the ProtoHandler itself after being called.
+    /// this should start a subscribe loop in a [`tokio::spawn`] thread, and return the [`tokio::task::JoinHandle`] .
+    /// this consumes the `SubscribeProtoHandler` itself after being called.
     fn begin_subscribe_loop(
         self,
         config_topic: String,

shared-deps/src/protocols/mqtt/init.rs

@@ -12,6 +12,9 @@ use crate::{
 };
 
 /// Sets up the MQTT proto handlers, and verifies that we can connect to the MQTT broker.
+///
+/// # Errors
+///   - If we can't make an initial connection to the broker, return Err.
 pub async fn init_mqtt_proto_handlers(
     broker_config: &BrokerSettings,
     application_name: &'static str,

shared-deps/src/protocols/mqtt/publish.rs

@@ -6,7 +6,7 @@ use crate::protocols::proxy::is_routing_key_compliant;
 #[derive(Clone)]
 pub struct MqttPublishProtoHandler {
     mqtt_client: AsyncClient,
-    /// application_name is used for the hardcoded queue name and for debugging purposes
+    /// `application_name` is used for the hardcoded queue name and for debugging purposes
     application_name: &'static str,
 }
 
@@ -19,6 +19,7 @@ impl std::fmt::Debug for MqttPublishProtoHandler {
 }
 
 impl MqttPublishProtoHandler {
+    #[must_use]
     pub fn new(application_name: &'static str, mqtt_client: AsyncClient) -> Self {
         MqttPublishProtoHandler {
             mqtt_client,

shared-deps/src/protocols/mqtt/subscribe.rs

@@ -13,7 +13,7 @@ use crate::{
 pub struct MqttSubscribeProtoHandler {
     mqtt_client: AsyncClient,
     mqtt_event_loop: EventLoop,
-    /// application_name is used for the hardcoded queue name and for debugging purposes
+    /// `application_name` is used for the hardcoded queue name and for debugging purposes
     application_name: &'static str,
 }
 
@@ -108,7 +108,7 @@ async fn broker_consumer_loop_inner(
                                 break false;
                             },
                             () = &mut retry_wait => {
-                                continue;
+                                // no-op
                             },
                         }
                     },

shared-deps/src/protocols/mqtt/utils.rs

@@ -11,5 +11,5 @@ pub(crate) async fn subscribe_all(mqtt_client: &AsyncClient) -> Result<(), Strin
 ///
 /// this should generally happen at some point in the subscribe loop
 pub(crate) fn mqtt_topic_to_proxy_topic(topic: &str) -> String {
-    topic.replace("/", ".")
+    topic.replace('/', ".")
 }