Merge pull request #157 from quartiq/bump-embedded-nal

bump embedded-nal

Cargo.toml

@@ -23,7 +23,7 @@ embedded-time = "0.12"
 varint-rs = {version = "2.2", default-features = false }
 serde = { version = "1", features = ["derive"], default-features = false }
 smlang = "0.6.0"
-embedded-nal = "0.7"
+embedded-nal = "0.8"
 
 [features]
 default = []
@@ -33,5 +33,5 @@ unsecure = []
 [dev-dependencies]
 log = "0.4"
 env_logger = "0.10"
-std-embedded-nal = "0.2"
 std-embedded-time = "0.1"
+std-embedded-nal = { git = "https://gitlab.com/ryan-summers/std-embedded-nal", branch = "feature/0.8" }

src/config.rs

@@ -95,8 +95,8 @@ impl<'a, Broker: crate::Broker> ConfigBuilder<'a, Broker> {
     /// Specify a specific configuration for the session state buffer.
     ///
     /// # Note
-    /// The session state buffer is used for publications greater than [QoS::AtMostOnce]. If these
-    /// messages are unused, you can specify [BufferConfig::Exactly(0)].
+    /// The session state buffer is used for publications greater than [crate::QoS::AtMostOnce]. If
+    /// these messages are unused, you can specify [BufferConfig::Exactly(0)].
     ///
     /// # Args
     /// * `config` - The configuration for the size of the session state buffer.
@@ -144,8 +144,8 @@ impl<'a, Broker: crate::Broker> ConfigBuilder<'a, Broker> {
         self
     }
 
-    /// Specify if publication [QoS] should be automatically downgraded to the maximum supported by
-    /// the server if they exceed the server [QoS] maximum.
+    /// Specify if publication [crate::QoS] should be automatically downgraded to the maximum
+    /// supported by the server if they exceed the server [crate::QoS] maximum.
     pub fn autodowngrade_qos(mut self) -> Self {
         self.downgrade_qos = true;
         self

src/mqtt_client.rs

@@ -379,8 +379,8 @@ impl<'buf, TcpStack: TcpClientStack, Clock: embedded_time::Clock, Broker: crate:
     /// If the client is not yet connected to the broker, the message will be silently ignored.
     ///
     /// # Args
-    /// * `publish` - The publication to generate. See [Publication] for a builder pattern to
-    /// generate a message.
+    /// * `publish` - The publication to generate. See [crate::Publication] for a builder pattern
+    /// to generate a message.
     pub fn publish<P: crate::publication::ToPayload>(
         &mut self,
         mut publish: Pub<'_, P>,
@@ -738,8 +738,8 @@ impl<'buf, TcpStack: TcpClientStack, Clock: embedded_time::Clock, Broker: crate:
     /// topic, message, and list of proprties (in that order).
     ///
     /// # Returns
-    /// Ok(Option<result>) - During normal operation, a <result> will optionally be returned to the
-    /// user software if a value was returned from the `f` closure. If the closure was not
+    /// `Ok(Option<result>)` - During normal operation, a `result` will optionally be returned to
+    /// the user software if a value was returned from the `f` closure. If the closure was not
     /// executed, `None` is returned. Note that `None` may be returned even if MQTT packets were
     /// processed.
     ///

src/publication.rs

@@ -132,7 +132,7 @@ impl<'a, P: ToPayload> Publication<'a, P> {
     ///
     /// # Note
     /// The received message properties are parsed for both [Property::CorrelationData] and
-    /// [PropertyResponseTopic].
+    /// [Property::ResponseTopic].
     ///
     /// * If correlation data is found, it is automatically appended to the
     /// publication properties.