Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: hyperlinks in doc and ignore test dependent on speed of execution #476

Merged
merged 4 commits into from
Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions benchmarks/simplerouter/src/protocol/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pub mod v5;

/// Checks if the filter is valid
///
/// https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106>
pub fn valid_filter(filter: &str) -> bool {
if filter.is_empty() {
return false;
Expand Down Expand Up @@ -138,7 +138,7 @@ pub fn qos(num: u8) -> Result<QoS, Error> {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/mqttbytes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ pub enum QoS {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/v5/mqttbytes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ pub fn valid_topic(topic: &str) -> bool {

/// Checks if the filter is valid
///
/// https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106>
pub fn valid_filter(filter: &str) -> bool {
if filter.is_empty() {
return false;
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/v5/mqttbytes/v5/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ enum PropertyType {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/v5/mqttbytes/v5/pubcomp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubcomp: &PubComp, properties: &Option<PubCompProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBCOMP has a Remaining Length of 2.
// ref: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154>
if pubcomp.reason == PubCompReason::Success && properties.is_none() {
return 2;
}
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/v5/mqttbytes/v5/pubrec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubrec: &PubRec, properties: &Option<PubRecProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBREC has a Remaining Length of 2.
// As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134>
if pubrec.reason == PubRecReason::Success && properties.is_none() {
return 2;
}
Expand Down
2 changes: 1 addition & 1 deletion rumqttc/src/v5/mqttbytes/v5/pubrel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubrel: &PubRel, properties: &Option<PubRelProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBREL has a Remaining Length of 2.
// As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144>
if pubrel.reason == PubRelReason::Success && properties.is_none() {
return 2;
}
Expand Down
1 change: 1 addition & 0 deletions rumqttc/tests/reliability.rs
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ async fn requests_are_recovered_after_inflight_queue_size_falls_below_max() {
assert!(broker.read_publish().await.is_none());
}

#[ignore]
#[tokio::test]
async fn packet_id_collisions_are_detected_and_flow_control_is_applied() {
let mut options = MqttOptions::new("dummy", "127.0.0.1", 1891);
Expand Down
2 changes: 1 addition & 1 deletion rumqttd-old/src/mqttbytes/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ pub enum QoS {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ pub fn valid_topic(topic: &str) -> bool {

/// Checks if the filter is valid
///
/// https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106>
pub fn valid_filter(filter: &str) -> bool {
if filter.is_empty() {
return false;
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/v4/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ pub enum PacketType {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/v5/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ enum PropertyType {
/// | Remaining Bytes Len (1/2/3/4 bytes) |
/// +-----------------------------------------------------+
///
/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub struct FixedHeader {
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/v5/pubcomp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubcomp: &PubComp, properties: &Option<PubCompProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBCOMP has a Remaining Length of 2.
// ref: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154>
if pubcomp.reason == PubCompReason::Success && properties.is_none() {
return 2;
}
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/v5/pubrec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubrec: &PubRec, properties: &Option<PubRecProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBREC has a Remaining Length of 2.
// As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134>
if pubrec.reason == PubRecReason::Success && properties.is_none() {
return 2;
}
Expand Down
2 changes: 1 addition & 1 deletion rumqttd/src/protocol/v5/pubrel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fn len(pubrel: &PubRel, properties: &Option<PubRelProperties>) -> usize {

// The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
// and there are no Properties. In this case the PUBREL has a Remaining Length of 2.
// As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144
// <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144>
if pubrel.reason == PubRelReason::Success && properties.is_none() {
return 2;
}
Expand Down