chore: Merge branch 'release/0.10.0'

BenLeadbetter · BenLeadbetter · commit ded766974755 · 2025-07-27T12:06:04.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.10.0](https://github.com/midi2-dev/bl-midi2-rs/compare/0.9.0..0.10.0) - 2025-07-27
+
+### 🐛 Fixes
+
+- Rust 1.90.0 clippy warnings - ([5f24196](https://github.com/midi2-dev/bl-midi2-rs/commit/5f24196b16171a65587ef3fbaa42673717af23ac))
+- U20 for Delta Clockstamp Ticks Since Last Event per spec - ([9bfa4de..2d5713e](https://github.com/midi2-dev/bl-midi2-rs/compare/9bfa4de5b399e42682993adacece0cd79c7cf038..2d5713e762f09e468cd0ec6ffb0d7037ce95df7f))
+- Clippy warnings from rust 1.87.0 - ([9bfa4de](https://github.com/midi2-dev/bl-midi2-rs/commit/9bfa4de5b399e42682993adacece0cd79c7cf038))
+
+### 📚 Documentation
+
+- Improve the wording and details of the contributing docs - ([](https://github.com/midi2-dev/bl-midi2-rs/commit/a30428f294c5ca6e8c97bf3cbc1f2436797893a6))
+
+## New Contributors ❤️
+
+* @dpezely made their first contribution in [#73](https://github.com/midi2-dev/bl-midi2-rs/pull/73)
+
 ## [0.9.0](https://github.com/midi2-dev/bl-midi2-rs/compare/0.8.2..0.9.0) - 2025-05-13
 
 ### ✨ Features
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,8 +8,8 @@ or open a PR from your own fork to start a discussion ☺️..
 
 ## 🪝 Hooks 🪝
 
-We recommend using the hooks while developing in this repository.
-The hooks manager is a python package which needs installing locally.
+It is recommended to use git hooks while developing in this repository.
+The hooks manager (pre-commit) is a python package which needs installing locally.
 The best way to do this is via a virtual environment.
 
 ```shell
@@ -22,18 +22,22 @@ The best way to do this is via a virtual environment.
 ## 🧱 Building 🧱
 
 To build, simply follow the usual cargo flow.
+
 ```shell
-> cargo build --all-features
+> cargo build --all --all-features
 ```
 
 ## Tests
 
-The project currently has a good unit tests coverage,
+The project currently has a unit test, and documentation test coverage,
 but no integration test coverage yet.
-To run the tests, follow the usual cargo flow.
+To run all the tests, follow the usual cargo flow.
+
+When adding new features please try to cover the new code
+with appropriate unit test cases.
 
 ```shell
-> cargo test --all-features
+> cargo test --all --all-features
 ```
 
 ## 🌍 A Tour of midi2 🌍 
diff --git a/README.md b/README.md
@@ -163,7 +163,7 @@ You'll want to setup midi2 without default features to compile
 without the `std` feature.
 
 ```toml
-midi2 = { version = "0.9.0", default-features = false, features = ["channel-voice2", "sysex7"],  }
+midi2 = { version = "0.10.0", default-features = false, features = ["channel-voice2", "sysex7"],  }
 ```
 
 ### Generic Representation
diff --git a/midi2/Cargo.toml b/midi2/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "midi2"
-version = "0.9.0"
+version = "0.10.0"
 description = "Ergonomic, versatile, strong types wrapping MIDI 2.0 message data."
 edition = "2021"
 readme = "README.md"
@@ -17,7 +17,7 @@ manual_div_ceil = "allow"
 [dependencies]
 derive_more = { version = "2.0.1", features = ["from"], default-features = false }
 fixed = "1.28.0"
-midi2_proc = { version = "0.9.0", path = "../midi2_proc" }
+midi2_proc = { version = "0.10.0", path = "../midi2_proc" }
 ux = "0.1.6"
 
 [dev-dependencies]
diff --git a/midi2/src/detail/common_properties.rs b/midi2/src/detail/common_properties.rs
@@ -165,60 +165,6 @@ impl<
     }
 }
 
-pub struct BytesSchemaProperty<T, B: schema::BytesSchema>(core::marker::PhantomData<(T, B)>);
-
-impl<
-        B: Buffer,
-        BytesSchema: schema::BytesSchema,
-        T: Default + schema::BytesSchemaRepr<BytesSchema>,
-    > Property<B> for BytesSchemaProperty<T, BytesSchema>
-{
-    type Type = T;
-}
-
-impl<
-        'a,
-        B: Buffer,
-        BytesSchema: schema::BytesSchema,
-        T: Default + schema::BytesSchemaRepr<BytesSchema>,
-    > ReadProperty<'a, B> for BytesSchemaProperty<T, BytesSchema>
-{
-    fn read(buffer: &'a B) -> Self::Type {
-        match <B::Unit as UnitPrivate>::UNIT_ID {
-            UNIT_ID_U32 => Default::default(),
-            UNIT_ID_U8 => {
-                <T as schema::BytesSchemaRepr<BytesSchema>>::read(buffer.buffer().specialise_u8())
-            }
-            _ => unreachable!(),
-        }
-    }
-    fn validate(_buffer: &B) -> Result<(), crate::error::InvalidData> {
-        Ok(())
-    }
-}
-
-impl<
-        B: Buffer + BufferMut,
-        BytesSchema: schema::BytesSchema,
-        T: Default + schema::BytesSchemaRepr<BytesSchema>,
-    > WriteProperty<B> for BytesSchemaProperty<T, BytesSchema>
-{
-    fn write(buffer: &mut B, v: Self::Type) {
-        if <B::Unit as UnitPrivate>::UNIT_ID == UNIT_ID_U8 {
-            <T as schema::BytesSchemaRepr<BytesSchema>>::write(
-                buffer.buffer_mut().specialise_u8_mut(),
-                v,
-            )
-        }
-    }
-    fn validate(_v: &Self::Type) -> Result<(), crate::error::InvalidData> {
-        Ok(())
-    }
-    fn default() -> Self::Type {
-        Default::default()
-    }
-}
-
 pub struct UmpSchemaProperty<T, B: schema::UmpSchema>(core::marker::PhantomData<(T, B)>);
 
 impl<B: Buffer, UmpSchema: schema::UmpSchema, T: Default + schema::UmpSchemaRepr<UmpSchema>>
diff --git a/midi2/src/flex_data/text.rs b/midi2/src/flex_data/text.rs
@@ -63,7 +63,7 @@ impl<B: Ump + BufferMut> ResizeProperty<B> for TextWriteStrProperty<'_> {
 
 fn ump_buffer_size_for_str(s: &str) -> usize {
     let str_size = s.len();
-    if str_size % 12 == 0 {
+    if str_size.is_multiple_of(12) {
         if str_size == 0 {
             4
         } else {
@@ -78,7 +78,7 @@ fn grow_buffer(mut buffer: &mut [u32], size: usize) {
     use crate::detail::BitOps;
     use crate::ux::{u2, u4};
 
-    debug_assert!(size % 4 == 0);
+    debug_assert!(size.is_multiple_of(4));
     debug_assert!(size != 0);
 
     let group = buffer[0].nibble(1);
diff --git a/midi2/src/packets.rs b/midi2/src/packets.rs
@@ -70,5 +70,5 @@ impl core::iter::ExactSizeIterator for PacketsIterator<'_> {
 /// assert_eq!(packets.next(), None);
 /// ```
 pub trait Packets {
-    fn packets(&self) -> PacketsIterator;
+    fn packets<'a>(&'a self) -> PacketsIterator<'a>;
 }
diff --git a/midi2/src/sysex7.rs b/midi2/src/sysex7.rs
@@ -808,7 +808,7 @@ fn try_resize_ump<
 }
 
 fn buffer_size_from_payload_size_ump(payload_size: usize) -> usize {
-    if payload_size % 6 == 0 {
+    if payload_size.is_multiple_of(6) {
         if payload_size == 0 {
             2
         } else {
diff --git a/midi2/src/sysex7/packet.rs b/midi2/src/sysex7/packet.rs
@@ -135,7 +135,7 @@ impl Packet {
         status_from_data(&self.0[..]).unwrap()
     }
 
-    pub fn payload(&self) -> PayloadIterator {
+    pub fn payload<'a>(&'a self) -> PayloadIterator<'a> {
         PayloadIterator {
             data: &self.0,
             index: 0,
diff --git a/midi2/src/sysex8.rs b/midi2/src/sysex8.rs
@@ -565,7 +565,7 @@ fn try_resize<
 }
 
 fn buffer_size_from_payload_size(payload_size: usize) -> usize {
-    if payload_size % 13 == 0 {
+    if payload_size.is_multiple_of(13) {
         if payload_size == 0 {
             4
         } else {
diff --git a/midi2/src/sysex8/packet.rs b/midi2/src/sysex8/packet.rs
@@ -165,7 +165,7 @@ impl Packet {
     pub fn stream_id(&self) -> u8 {
         sysex8::stream_id_from_packet(&self.0[..])
     }
-    pub fn payload(&self) -> PayloadIterator {
+    pub fn payload<'a>(&'a self) -> PayloadIterator<'a> {
         PayloadIterator {
             data: &self.0,
             index: 0,
diff --git a/midi2/src/ump_stream.rs b/midi2/src/ump_stream.rs
@@ -387,7 +387,7 @@ fn clear_payload<const OFFSET: usize>(buffer: &mut [u32]) {
 fn required_buffer_size_for_str<const OFFSET: usize>(s: &str) -> usize {
     let str_size = s.len();
     let packet_capacity = 14 - OFFSET;
-    if str_size % packet_capacity == 0 {
+    if str_size.is_multiple_of(packet_capacity) {
         if str_size == 0 {
             4
         } else {
diff --git a/midi2/src/utility.rs b/midi2/src/utility.rs
@@ -97,15 +97,46 @@ mod timestamp {
 mod delta_clockstamp {
     use crate::detail::common_properties;
     use crate::utility;
+    use crate::ux::u20;
     pub const STATUS: u8 = 0b0100;
     #[midi2_proc::generate_message(Via(crate::utility::Utility), FixedSize, MinSizeUmp(1))]
     struct DeltaClockstamp {
         #[property(common_properties::UmpMessageTypeProperty<{utility::UMP_MESSAGE_TYPE}>)]
         ump_type: (),
         #[property(common_properties::ChannelVoiceStatusProperty<STATUS>)]
         status: (),
-        #[property(utility::DataProperty)]
-        time_data: u16,
+        #[property(DataProperty)]
+        time_data: u20,
+    }
+
+    struct DataProperty;
+
+    impl<B: crate::buffer::Ump> crate::detail::property::Property<B> for DataProperty {
+        type Type = u20;
+    }
+
+    impl<'a, B: crate::buffer::Ump> crate::detail::property::ReadProperty<'a, B> for DataProperty {
+        fn read(buffer: &'a B) -> Self::Type {
+            u20::new(buffer.buffer()[0] & 0x000F_FFFF)
+        }
+        fn validate(_buffer: &B) -> Result<(), crate::error::InvalidData> {
+            Ok(())
+        }
+    }
+
+    impl<B: crate::buffer::Ump + crate::buffer::BufferMut> crate::detail::property::WriteProperty<B>
+        for DataProperty
+    {
+        fn write(buffer: &mut B, value: Self::Type) {
+            buffer.buffer_mut()[0] &= !0x000F_FFFF;
+            buffer.buffer_mut()[0] |= u32::from(value);
+        }
+        fn validate(_v: &Self::Type) -> Result<(), crate::error::InvalidData> {
+            Ok(())
+        }
+        fn default() -> Self::Type {
+            Default::default()
+        }
     }
 }
 mod delta_clockstamp_tpq {
@@ -260,6 +291,19 @@ mod tests {
         DeltaClockstamp::try_from(&[0x0040_0000][..]).unwrap();
     }
 
+    #[test]
+    fn delta_clock_stamp_u20() {
+        use crate::ux::u20;
+
+        let dc = DeltaClockstamp::try_from(&[0x004A_BCDE][..]).unwrap();
+        assert_eq!(dc.time_data(), u20::new(0xABCDE));
+
+        let buffer: [u32; 4] = [0, 0, 0, 0];
+        let mut dc = DeltaClockstamp::try_new_with_buffer(buffer).unwrap();
+        dc.set_time_data(u20::new(0x1_2345));
+        assert_eq!(dc.time_data(), u20::new(0x1_2345));
+    }
+
     #[test]
     fn delta_clock_stamp_tpq_try_from() {
         DeltaClockstampTpq::try_from(&[0x0030_0000][..]).unwrap();
diff --git a/midi2_proc/Cargo.toml b/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.9.0"
+version = "0.10.0"
 edition = "2021"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
diff --git a/midi2_proc/src/derives.rs b/midi2_proc/src/derives.rs
@@ -43,7 +43,7 @@ pub fn packets(item: TokenStream1) -> TokenStream1 {
     }
     quote! {
         impl<B: crate::buffer::Ump>  crate::Packets for #ident<B>  {
-            fn packets(&self) -> crate::PacketsIterator {
+            fn packets<'a>(&'a self) -> crate::PacketsIterator<'a> {
                 use #ident::*;
                 match self {
                     #match_arms
diff --git a/midi2_proc/src/generate_ci.rs b/midi2_proc/src/generate_ci.rs
@@ -220,7 +220,7 @@ fn property_setter(property: &Property, public: bool) -> TokenStream {
 
     if property.resize {
         let fallible_ident = syn::Ident::new(
-            format!("try_{}", ident).as_str(),
+            format!("try_{ident}").as_str(),
             proc_macro2::Span::call_site(),
         );
         quote! {
diff --git a/midi2_proc/src/generate_message.rs b/midi2_proc/src/generate_message.rs
@@ -177,7 +177,7 @@ fn property_setter(property: &Property, public: bool) -> TokenStream {
 
     if property.resize {
         let fallible_ident = syn::Ident::new(
-            format!("try_{}", ident).as_str(),
+            format!("try_{ident}").as_str(),
             proc_macro2::Span::call_site(),
         );
         quote! {
@@ -339,7 +339,7 @@ fn data_impl(root_ident: &syn::Ident, args: &GenerateMessageArgs) -> TokenStream
 fn packets_impl(root_ident: &syn::Ident) -> TokenStream {
     quote! {
         impl<B: crate::buffer::Ump> crate::Packets for #root_ident<B> {
-            fn packets(&self) -> crate::PacketsIterator {
+            fn packets<'a>(&'a self) -> crate::PacketsIterator<'a> {
                 crate::PacketsIterator(self
                     .data()
                     .chunks_exact(<Self as crate::traits::MinSize<B>>::MIN_SIZE)

Original file line number	Diff line number	Diff line change
`@@ -70,5 +70,5 @@ impl core::iter::ExactSizeIterator for PacketsIterator<'_> {`
`70`	`70`	`/// assert_eq!(packets.next(), None);`
`71`	`71`	/// ```
`72`	`72`	`pub trait Packets {`
`73`		`- fn packets(&self) -> PacketsIterator;`
	`73`	`+ fn packets<'a>(&'a self) -> PacketsIterator<'a>;`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -808,7 +808,7 @@ fn try_resize_ump<`
`808`	`808`	`}`
`809`	`809`
`810`	`810`	`fn buffer_size_from_payload_size_ump(payload_size: usize) -> usize {`
`811`		`- if payload_size % 6 == 0 {`
	`811`	`+ if payload_size.is_multiple_of(6) {`
`812`	`812`	`if payload_size == 0 {`
`813`	`813`	`2`
`814`	`814`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ impl Packet {`
`135`	`135`	`status_from_data(&self.0[..]).unwrap()`
`136`	`136`	`}`
`137`	`137`
`138`		`- pub fn payload(&self) -> PayloadIterator {`
	`138`	`+ pub fn payload<'a>(&'a self) -> PayloadIterator<'a> {`
`139`	`139`	`PayloadIterator {`
`140`	`140`	`data: &self.0,`
`141`	`141`	`index: 0,`
Original file line number	Diff line number	Diff line change
`@@ -565,7 +565,7 @@ fn try_resize<`
`565`	`565`	`}`
`566`	`566`
`567`	`567`	`fn buffer_size_from_payload_size(payload_size: usize) -> usize {`
`568`		`- if payload_size % 13 == 0 {`
	`568`	`+ if payload_size.is_multiple_of(13) {`
`569`	`569`	`if payload_size == 0 {`
`570`	`570`	`4`
`571`	`571`	`} else {`