port changes from upstream master

Signed-off-by: Andrei Gherghescu <[email protected]>
andrei-ng · Sep 11, 2023 · f78d322 · f78d322
1 parent 1d90a85
commit f78d322
Show file tree

Hide file tree

Showing 13 changed files with 413 additions and 454 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,8 @@
-# IDEs
-.idea/
-.vscode
+Cargo.lock
+target/
 
-# Rust specific
-/target
 **/*.rs.bk
 *~
-Cargo.lock
+
+.idea/
+.vscode
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,2 +1,2 @@
 [workspace]
-members = ["ublox", "ublox_derive", "examples/*"]
+members = ["ublox", "ublox_derive"]
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -0,0 +1,3 @@
+[workspace]
+exclude = ["target"]
+members = ["*"]
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,11 @@
+# Examples
+
+This folder contains usage examples.
+
+These examples use a more recent `rustc` compiler version than the library.
+
+To build the examples, you can override the toolchain used specifically to this folder by doing, e.g.,
+```
+rustup install 1.70
+rustup override set 1.70
+```
diff --git a/ublox/Cargo.toml b/ublox/Cargo.toml
@@ -24,6 +24,7 @@ ublox_derive = {path = "../ublox_derive", version = "0.0.4"}
 [dev-dependencies]
 cpu-time = "1.0.0"
 cpuprofiler = "0.0.4"
+# Latest depends on clap v4 which requires rustc 1.70
 criterion = "0.4.0"
 rand = "0.8.5"
 serde_json = "1.0.85"

diff --git a/ublox/benches/packet_benchmark.rs b/ublox/benches/packet_benchmark.rs
@@ -22,6 +22,7 @@ fn profiled() -> Criterion {
     Criterion::default().with_profiler(CpuProfiler)
 }
 
+#[allow(dead_code)]
 fn parse_all<T: UnderlyingBuffer>(mut parser: Parser<T>, data: &[u8], chunk_size: usize) -> usize {
     let mut count = 0;
     for chunk in data.chunks(chunk_size) {
@@ -48,20 +49,24 @@ pub fn criterion_benchmark(c: &mut Criterion) {
     for chunk in &[99, 100, 101, 256, 512, 1000, 1024] {
         c.bench_function(&format!("vec_parse_pos_{}", chunk), |b| {
             b.iter(|| {
-                let data = std::include_bytes!("pos.ubx");
-                let parser = Parser::default();
-                assert_eq!(parse_all(parser, data, *chunk), 2801);
+                // TODO: requires pos.ubx file
+                // let data = std::include_bytes!("pos.ubx");
+                // let parser = Parser::default();
+                // assert_eq!(parse_all(parser, data, *chunk), 2801);
+                todo!()
             })
         });
     }
     for (buf_size, chunk) in &[(256, 100), (256, 256), (256, 512), (256, 1024)] {
-        let mut underlying = vec![0; *buf_size];
+        // let mut underlying = vec![0; *buf_size];
         c.bench_function(&format!("array_parse_pos_{}_{}", buf_size, chunk), |b| {
             b.iter(|| {
-                let data = std::include_bytes!("pos.ubx");
-                let underlying = FixedLinearBuffer::new(&mut underlying);
-                let parser = Parser::new(underlying);
-                assert_eq!(parse_all(parser, data, *chunk), 2801);
+                // TODO: requires pos.ubx file
+                // let data = std::include_bytes!("pos.ubx");
+                // let underlying = FixedLinearBuffer::new(&mut underlying);
+                // let parser = Parser::new(underlying);
+                // assert_eq!(parse_all(parser, data, *chunk), 2801);
+                todo!()
             })
         });
     }

diff --git a/ublox/src/parser.rs b/ublox/src/parser.rs
@@ -150,7 +150,7 @@ impl<'a> UnderlyingBuffer for FixedLinearBuffer<'a> {
     }
 
     fn find(&self, value: u8) -> Option<usize> {
-        (0..self.len()).find(|&i| self.buffer[i] == value)
+        (0..self.len()).find(|&i| self[i] == value)
     }
 }
 
@@ -622,12 +622,9 @@ mod test {
 
         let mut dual = DualBuffer::new(&mut buf, &new[..]);
         // This should throw
-        match dual.take(6) {
-            Err(ParserError::OutOfMemory { required_size }) => {
-                assert_eq!(required_size, 6);
-            },
-            _ => assert!(false),
-        }
+        assert!(
+            matches!(dual.take(6), Err(ParserError::OutOfMemory { required_size }) if required_size == 6)
+        );
     }
 
     #[test]
@@ -766,12 +763,7 @@ mod test {
 
         let mut it = parser.consume(&bytes);
         for _ in 0..5 {
-            match it.next() {
-                Some(Ok(PacketRef::AckAck(_packet))) => {
-                    // We're good
-                },
-                _ => assert!(false),
-            }
+            assert!(matches!(it.next(), Some(Ok(PacketRef::AckAck(_)))));
         }
         assert!(it.next().is_none());
     }
@@ -786,12 +778,7 @@ mod test {
 
         {
             let mut it = parser.consume(&bytes);
-            match it.next() {
-                Some(Ok(PacketRef::AckAck(_packet))) => {
-                    // We're good
-                },
-                _ => assert!(false),
-            }
+            assert!(matches!(it.next(), Some(Ok(PacketRef::AckAck(_)))));
             assert!(it.next().is_none());
         }
     }
@@ -830,14 +817,9 @@ mod test {
 
         {
             let mut it = parser.consume(&bytes[8..]);
-            match it.next() {
-                Some(Err(ParserError::OutOfMemory { required_size })) => {
-                    assert_eq!(required_size, bytes.len() - 6);
-                },
-                _ => {
-                    assert!(false);
-                },
-            }
+            assert!(
+                matches!(it.next(), Some(Err(ParserError::OutOfMemory { required_size })) if required_size == bytes.len() - 6)
+            );
             assert!(it.next().is_none());
         }
 
@@ -846,12 +828,7 @@ mod test {
 
         {
             let mut it = parser.consume(&bytes);
-            match it.next() {
-                Some(Ok(PacketRef::AckAck(_packet))) => {
-                    // We're good
-                },
-                _ => assert!(false),
-            }
+            assert!(matches!(it.next(), Some(Ok(PacketRef::AckAck(_)))));
             assert!(it.next().is_none());
         }
     }
@@ -883,14 +860,7 @@ mod test {
         let buffer = FixedLinearBuffer::new(&mut buffer);
         let mut parser = Parser::new(buffer);
         let mut it = parser.consume(&bytes);
-        match it.next() {
-            Some(Ok(PacketRef::CfgNav5(_packet))) => {
-                // We're good
-            },
-            _ => {
-                assert!(false);
-            },
-        }
+        assert!(matches!(it.next(), Some(Ok(PacketRef::CfgNav5(_)))));
         assert!(it.next().is_none());
     }
 
@@ -920,14 +890,7 @@ mod test {
 
         let mut parser = Parser::default();
         let mut it = parser.consume(&bytes);
-        match it.next() {
-            Some(Ok(PacketRef::CfgNav5(_packet))) => {
-                // We're good
-            },
-            _ => {
-                assert!(false);
-            },
-        }
+        assert!(matches!(it.next(), Some(Ok(PacketRef::CfgNav5(_)))));
         assert!(it.next().is_none());
     }
 
@@ -958,7 +921,7 @@ mod test {
                 assert_eq!(packet.pacc(), 21);
             },
             _ => {
-                assert!(false);
+                panic!()
             },
         }
         match it.next() {
@@ -967,13 +930,14 @@ mod test {
                 assert_eq!(packet.pacc(), 18);
             },
             _ => {
-                assert!(false);
+                panic!()
             },
         }
         assert!(it.next().is_none());
     }
 
     #[test]
+    #[allow(clippy::assertions_on_constants)]
     fn test_max_payload_len() {
         assert!(MAX_PAYLOAD_LEN >= 1240);
     }