Merge branch 'release/0.3.1'

Author: Ben Leadbetter

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.3.1
+docs: fix typos in readme
+fix: panic on empty flex-data text iterator
+fix: panic on empty ump-stream text iterator
+
 # 0.3.0
 docs: fix further readme typos
 feat: utility messages are integrated into top level aggregate

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "midi2"
-version = "0.3.0"
+version = "0.3.1"
 description = "Ergonomic, versatile, strong types wrapping MIDI 2.0 message data."
 edition = "2021"
 readme = "README.md"
@@ -35,7 +35,7 @@ utility = []
 
 [dependencies]
 derive_more = { version = "0.99.17", features = ["from"], default-features = false }
-midi2_proc = { version = "0.3.0", path = "midi2_proc" }
+midi2_proc = { version = "0.3.1", path = "midi2_proc" }
 ux = "0.1.6"
 
 [dev-dependencies]

README.md

@@ -156,7 +156,7 @@ You'll want to setup midi2 without default features to compile
 without the `std` feature.
 
 ```toml
-midi2 = { version = "0.3.0", default-features = false, features = ["channel-voice2", "sysex7"],  }
+midi2 = { version = "0.3.1", default-features = false, features = ["channel-voice2", "sysex7"],  }
 ```
 
 ### Generic Representation
@@ -207,12 +207,10 @@ let buffer = [
     0x4441_5733,
     0x362D_3136,
 ];
-let Ok(message) = UmpMessage::try_from(&buffer[..]) else {
-    panic!();
-};
+let message = UmpMessage::try_from(&buffer[..]).expect("Valid data");
 ```
 
-Of course this means that such borrowed messages are imutable
+Of course this means that such borrowed messages are immutable
 and also have their lifetimes tied to the original buffer.
 
 To remedy this messages can be `rebuffered` into a different
@@ -226,12 +224,12 @@ use midi2::{
 
 let mut owned: NoteOn::<[u32; 4]> = {
     let buffer = [0x4898_5E03_u32, 0x6A14_E98A];
-    // the borrowed message is imutable and cannot outlive `buffer`
+    // the borrowed message is immutable and cannot outlive `buffer`
     let borrowed = NoteOn::try_from(&buffer[..]).expect("Data is valid");
     borrowed.try_rebuffer_into().expect("Buffer is large enough")
 };
 
-// the owned message is mutable an liberated from the buffer lifetime.
+// the owned message is mutable and liberated from the buffer lifetime.
 owned.set_channel(u4::new(0x9));
 assert_eq!(owned.data(), &[0x4899_5E03, 0x6A14_E98A])
 ```

midi2_proc/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "midi2_proc"
 description = "Internal procedural macro crate. Only intended for use with midi2"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 readme = "README.md"
 license = "MIT OR Apache-2.0"

src/flex_data/text.rs

@@ -123,14 +123,14 @@ pub struct TextBytesIterator<'a> {
 impl<'a> core::iter::Iterator for TextBytesIterator<'a> {
     type Item = u8;
     fn next(&mut self) -> Option<Self::Item> {
+        while !self.finished() && self.value() == 0 {
+            self.advance();
+        }
         if self.finished() {
             return None;
         }
         let ret = Some(self.value());
         self.advance();
-        while !self.finished() && self.value() == 0 {
-            self.advance();
-        }
         ret
     }
 
@@ -143,7 +143,7 @@ impl<'a> core::iter::FusedIterator for TextBytesIterator<'a> {}
 
 impl<'a> TextBytesIterator<'a> {
     fn finished(&self) -> bool {
-        self.buffer.len() / 4 <= self.packet_index
+        self.packet_index == self.buffer.len() / 4 - 1 && self.byte_index == 11
     }
     fn advance(&mut self) {
         self.byte_index += 1;

src/flex_data/unknown_metadata_text.rs

@@ -389,6 +389,16 @@ mod tests {
         )
     }
 
+    #[test]
+    fn read_empty_text_bytes() {
+        assert_eq!(
+            UnknownMetadataText::<std::vec::Vec<u32>>::new()
+                .text_bytes()
+                .collect::<std::vec::Vec<u8>>(),
+            std::vec![],
+        )
+    }
+
     #[test]
     #[cfg(feature = "std")]
     fn read_string() {

src/ump_stream/endpoint_name.rs

@@ -97,4 +97,14 @@ mod tests {
         let message = EndpointName::try_from(&buffer[..]).unwrap();
         assert_eq!(message.name(), "Gimme some signal 🔊 🙌");
     }
+
+    #[test]
+    fn read_empty_bytes() {
+        assert_eq!(
+            EndpointName::<std::vec::Vec<u32>>::new()
+                .name_bytes()
+                .collect::<std::vec::Vec<u8>>(),
+            std::vec![]
+        );
+    }
 }

src/ump_stream/function_block_name.rs

@@ -190,4 +190,14 @@ mod tests {
             0x9,
         );
     }
+
+    #[test]
+    fn read_empty_bytes() {
+        assert_eq!(
+            FunctionBlockName::<std::vec::Vec<u32>>::new()
+                .name_bytes()
+                .collect::<std::vec::Vec<u8>>(),
+            std::vec![],
+        );
+    }
 }

src/ump_stream/mod.rs

@@ -268,14 +268,14 @@ pub struct TextBytesIterator<'a> {
 impl<'a> core::iter::Iterator for TextBytesIterator<'a> {
     type Item = u8;
     fn next(&mut self) -> Option<Self::Item> {
+        while !self.finished() && self.value() == 0 {
+            self.advance();
+        }
         if self.finished() {
             return None;
         }
         let ret = Some(self.value());
         self.advance();
-        while !self.finished() && self.value() == 0 {
-            self.advance();
-        }
         ret
     }