update deps + loosen some requirements (#12)

melekes · web-flow · commit 5c6e1d05a7fa · 2022-06-27T15:16:46.000+04:00
* update deps + loosen some requirements rules: - for crates that are below v1.0 -> specify the precise version - If the code uses a feature that was added for example in X 0.3.17, then you should specify 0.3.17, which actually means "0.3.y where y >= 17" - for crates the are above or equal v1.0 -> specify only major version if the crate's API is minimal and won't change between minor versions OR specify major&minor versions otherwise tested with https://github.com/taiki-e/cargo-minimal-versions * fix warnings
diff --git a/.github/workflows/cargo.yml b/.github/workflows/cargo.yml
@@ -10,41 +10,76 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
-    name: Build and test
+  check_and_test:
+    name: Check and test
     strategy:
       matrix:
         os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        toolchain:
+          - 1.56.1 # min supported version (https://github.com/webrtc-rs/webrtc/#toolchain)
+          - stable
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Build
-        run: cargo build --verbose
-      - name: Run tests
-        run: cargo test --verbose
+      - uses: actions/checkout@v3
+      - name: Cache cargo registry
+        uses: actions/cache@v3
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          profile: minimal
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
 
   rustfmt_and_clippy:
-    name: Check rustfmt style && run clippy
+    name: Check rustfmt style and run clippy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.55.0
+          toolchain: stable
           profile: minimal
           components: clippy, rustfmt
           override: true
       - name: Cache cargo registry
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ~/.cargo/registry
           key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
       - name: Run clippy
         uses: actions-rs/cargo@v1
         with:
           command: clippy
+          args: -- -D warnings
       - name: Check formating
         uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: --all -- --check
+
+  minimal_versions:
+    name: Compile and test with minimal versions
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install latest nightly
+        uses: actions-rs/toolchain@v1
+        with:
+            toolchain: nightly
+            override: true
+      - uses: taiki-e/install-action@cargo-hack
+      - uses: taiki-e/install-action@cargo-minimal-versions
+      - run: cargo minimal-versions check --workspace --all-features --ignore-private -v
+      - run: cargo minimal-versions build --workspace --all-features --ignore-private -v
+      - run: cargo minimal-versions test --workspace --all-features -v
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,10 +10,10 @@ homepage = "https://webrtc.rs"
 repository = "https://github.com/webrtc-rs/rtcp"
 
 [dependencies]
-util = { package = "webrtc-util", version = "0.5.3", default-features = false, features = ["marshal"] }
-bytes = "1.1.0"
-thiserror = "1.0.30"
+util = { package = "webrtc-util", version = "0.5.4", default-features = false, features = ["marshal"] }
+bytes = "1"
+thiserror = "1.0"
 
 [dev-dependencies]
-tokio = { version = "1.15.0", features = ["sync"] }
-tokio-test = "0.4.2"
+tokio = { version = "1.19", features = ["sync"] }
+tokio-test = "0.4.0" # must match the min version of the `tokio` crate above
diff --git a/src/compound_packet/compound_packet_test.rs b/src/compound_packet/compound_packet_test.rs
@@ -75,13 +75,14 @@ fn test_bad_compound() {
         compound_len, 2
     );
 
-    if let None = compound.0[0].as_any().downcast_ref::<Goodbye>() {
+    if compound.0[0].as_any().downcast_ref::<Goodbye>().is_none() {
         panic!("Unmarshal(badcompound), want Goodbye")
     }
 
-    if let None = compound.0[1]
+    if compound.0[1]
         .as_any()
         .downcast_ref::<PictureLossIndication>()
+        .is_none()
     {
         panic!("Unmarshal(badcompound), want PictureLossIndication")
     }
@@ -311,7 +312,7 @@ fn test_compound_packet_roundtrip() {
                     name, got, err
                 );
             } else {
-                assert!(false, "want error in test {}", name);
+                panic!("want error in test {}", name);
             }
             continue;
         } else {
diff --git a/src/extended_report/dlrr.rs b/src/extended_report/dlrr.rs
@@ -3,7 +3,7 @@ use super::*;
 const DLRR_REPORT_LENGTH: u16 = 12;
 
 /// DLRRReport encodes a single report inside a DLRRReportBlock.
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct DLRRReport {
     pub ssrc: u32,
     pub last_rr: u32,
@@ -34,7 +34,7 @@ impl fmt::Display for DLRRReport {
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ block
 /// :                               ...                             :   2
 /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct DLRRReportBlock {
     pub reports: Vec<DLRRReport>,
 }
diff --git a/src/extended_report/mod.rs b/src/extended_report/mod.rs
@@ -32,7 +32,7 @@ const XR_HEADER_LENGTH: usize = 4;
 
 /// BlockType specifies the type of report in a report block
 /// Extended Report block types from RFC 3611.
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum BlockType {
     Unknown = 0,
     LossRLE = 1,               // RFC 3611, section 4.1
@@ -93,7 +93,7 @@ pub type TypeSpecificField = u8;
 /// shouldn't need to access this. For locally-constructed report
 /// blocks, these values will not be accurate until the corresponding
 /// packet is marshaled.
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct XRHeader {
     pub block_type: BlockType,
     pub type_specific: TypeSpecificField,
diff --git a/src/extended_report/prt.rs b/src/extended_report/prt.rs
@@ -22,7 +22,7 @@ const PRT_REPORT_BLOCK_MIN_LENGTH: u16 = 8;
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 /// |       Receipt time of packet (end_seq - 1) mod 65536          |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct PacketReceiptTimesReportBlock {
     //not included in marshal/unmarshal
     pub t: u8,
diff --git a/src/extended_report/rle.rs b/src/extended_report/rle.rs
@@ -3,7 +3,7 @@ use super::*;
 const RLE_REPORT_BLOCK_MIN_LENGTH: u16 = 8;
 
 /// ChunkType enumerates the three kinds of chunks described in RFC 3611 section 4.1.
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum ChunkType {
     RunLength = 0,
     BitVector = 1,
@@ -36,7 +36,7 @@ pub enum ChunkType {
 ///  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///  |0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0|
 ///  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct Chunk(pub u16);
 
 impl fmt::Display for Chunk {
@@ -102,7 +102,7 @@ impl Chunk {
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 /// |          chunk n-1            |             chunk n           |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct RLEReportBlock {
     //not included in marshal/unmarshal
     pub is_loss_rle: bool,
diff --git a/src/extended_report/rrt.rs b/src/extended_report/rrt.rs
@@ -14,7 +14,7 @@ const RRT_REPORT_BLOCK_LENGTH: u16 = 8;
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 /// |             NTP timestamp, least significant word             |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct ReceiverReferenceTimeReportBlock {
     pub ntp_timestamp: u64,
 }
diff --git a/src/extended_report/ssr.rs b/src/extended_report/ssr.rs
@@ -28,7 +28,7 @@ const SSR_REPORT_BLOCK_LENGTH: u16 = 4 + 2 * 2 + 4 * 6 + 4;
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 /// | min_ttl_or_hl | max_ttl_or_hl |mean_ttl_or_hl | dev_ttl_or_hl |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct StatisticsSummaryReportBlock {
     //not included in marshal/unmarshal
     pub loss_reports: bool,
@@ -60,7 +60,7 @@ impl fmt::Display for StatisticsSummaryReportBlock {
 
 /// TTLorHopLimitType encodes values for the ToH field in
 /// a StatisticsSummaryReportBlock
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum TTLorHopLimitType {
     Missing = 0,
     IPv4 = 1,
diff --git a/src/extended_report/unknown.rs b/src/extended_report/unknown.rs
@@ -2,7 +2,7 @@ use super::*;
 
 /// UnknownReportBlock is used to store bytes for any report block
 /// that has an unknown Report Block Type.
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct UnknownReportBlock {
     pub bytes: Bytes,
 }
diff --git a/src/extended_report/vm.rs b/src/extended_report/vm.rs
@@ -26,7 +26,7 @@ const VM_REPORT_BLOCK_LENGTH: u16 = 4 + 4 + 2 * 4 + 10 + 2 * 3;
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 /// |          JB maximum           |          JB abs max           |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-#[derive(Debug, Default, PartialEq, Clone)]
+#[derive(Debug, Default, PartialEq, Eq, Clone)]
 pub struct VoIPMetricsReportBlock {
     pub ssrc: u32,
     pub loss_rate: u8,
diff --git a/src/goodbye/mod.rs b/src/goodbye/mod.rs
@@ -11,7 +11,7 @@ use std::fmt;
 type Result<T> = std::result::Result<T, util::Error>;
 
 /// The Goodbye packet indicates that one or more sources are no longer active.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct Goodbye {
     /// The SSRC/CSRC identifiers that are no longer active
     pub sources: Vec<u32>,
diff --git a/src/header.rs b/src/header.rs
@@ -5,7 +5,7 @@ use bytes::{Buf, BufMut};
 
 /// PacketType specifies the type of an RTCP packet
 /// RTCP packet types registered with IANA. See: https://www.iana.org/assignments/rtp-parameters/rtp-parameters.xhtml#rtp-parameters-4
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[repr(u8)]
 pub enum PacketType {
     Unsupported = 0,
@@ -88,7 +88,7 @@ pub const SSRC_LENGTH: usize = 4;
 pub const SDES_MAX_OCTET_COUNT: usize = (1 << 8) - 1;
 
 /// A Header is the common header shared by all RTCP packets
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct Header {
     /// If the padding bit is set, this individual RTCP packet contains
     /// some additional padding octets at the end which are not part of
diff --git a/src/packet.rs b/src/packet.rs
@@ -212,7 +212,7 @@ mod test {
             let want = Error::InvalidHeader;
             assert_eq!(want, got, "Unmarshal(nil) err = {}, want {}", got, want);
         } else {
-            assert!(false, "want error");
+            panic!("want error");
         }
 
         Ok(())
@@ -235,7 +235,7 @@ mod test {
                 got, want
             );
         } else {
-            assert!(false, "want error");
+            panic!("want error");
         }
 
         Ok(())
diff --git a/src/payload_feedbacks/full_intra_request/mod.rs b/src/payload_feedbacks/full_intra_request/mod.rs
@@ -11,7 +11,7 @@ use std::fmt;
 type Result<T> = std::result::Result<T, util::Error>;
 
 /// A FIREntry is a (ssrc, seqno) pair, as carried by FullIntraRequest.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct FirEntry {
     pub ssrc: u32,
     pub sequence_number: u8,
@@ -20,7 +20,7 @@ pub struct FirEntry {
 /// The FullIntraRequest packet is used to reliably request an Intra frame
 /// in a video stream.  See RFC 5104 Section 3.5.1.  This is not for loss
 /// recovery, which should use PictureLossIndication (PLI) instead.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct FullIntraRequest {
     pub sender_ssrc: u32,
     pub media_ssrc: u32,
diff --git a/src/payload_feedbacks/picture_loss_indication/mod.rs b/src/payload_feedbacks/picture_loss_indication/mod.rs
@@ -13,7 +13,7 @@ type Result<T> = std::result::Result<T, util::Error>;
 const PLI_LENGTH: usize = 2;
 
 /// The PictureLossIndication packet informs the encoder about the loss of an undefined amount of coded video data belonging to one or more pictures
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct PictureLossIndication {
     /// SSRC of sender
     pub sender_ssrc: u32,
diff --git a/src/payload_feedbacks/receiver_estimated_maximum_bitrate/receiver_estimated_maximum_bitrate_test.rs b/src/payload_feedbacks/receiver_estimated_maximum_bitrate/receiver_estimated_maximum_bitrate_test.rs
@@ -103,7 +103,7 @@ fn test_receiver_estimated_maximum_bitrate_overflow() {
     // exp = 63
     // bitrate = 0xFFFFC00000000000
 
-    let mut buf = output.clone();
+    let mut buf = output;
     let packet = ReceiverEstimatedMaximumBitrate::unmarshal(&mut buf).unwrap();
     assert_eq!(f32::from_bits(0x67FFFFC0), packet.bitrate);
 
diff --git a/src/payload_feedbacks/slice_loss_indication/mod.rs b/src/payload_feedbacks/slice_loss_indication/mod.rs
@@ -15,7 +15,7 @@ const SLI_OFFSET: usize = 8;
 
 /// SLIEntry represents a single entry to the SLI packet's
 /// list of lost slices.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct SliEntry {
     /// ID of first lost slice
     pub first: u16,
@@ -26,7 +26,7 @@ pub struct SliEntry {
 }
 
 /// The SliceLossIndication packet informs the encoder about the loss of a picture slice
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct SliceLossIndication {
     /// SSRC of sender
     pub sender_ssrc: u32,
diff --git a/src/raw_packet.rs b/src/raw_packet.rs
@@ -8,7 +8,7 @@ use std::fmt;
 
 /// RawPacket represents an unparsed RTCP packet. It's returned by Unmarshal when
 /// a packet with an unknown type is encountered.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct RawPacket(pub Bytes);
 
 impl fmt::Display for RawPacket {
diff --git a/src/receiver_report/mod.rs b/src/receiver_report/mod.rs
@@ -14,7 +14,7 @@ pub(super) const RR_SSRC_OFFSET: usize = HEADER_LENGTH;
 pub(super) const RR_REPORT_OFFSET: usize = RR_SSRC_OFFSET + SSRC_LENGTH;
 
 /// A ReceiverReport (RR) packet provides reception quality feedback for an RTP stream
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct ReceiverReport {
     /// The synchronization source identifier for the originator of this RR packet.
     pub ssrc: u32,
diff --git a/src/reception_report.rs b/src/reception_report.rs
@@ -15,7 +15,7 @@ pub(crate) const DELAY_OFFSET: usize = 20;
 
 /// A ReceptionReport block conveys statistics on the reception of RTP packets
 /// from a single synchronization source.
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct ReceptionReport {
     /// The SSRC identifier of the source to which the information in this
     /// reception report block pertains.
diff --git a/src/sender_report/mod.rs b/src/sender_report/mod.rs
@@ -24,7 +24,7 @@ pub(crate) const SR_OCTET_COUNT_OFFSET: usize = SR_PACKET_COUNT_OFFSET + SR_PACK
 pub(crate) const SR_OCTET_COUNT_LENGTH: usize = 4;
 
 /// A SenderReport (SR) packet provides reception quality feedback for an RTP stream
-#[derive(Debug, PartialEq, Default, Clone)]
+#[derive(Debug, PartialEq, Eq, Default, Clone)]
 pub struct SenderReport {
     /// The synchronization source identifier for the originator of this SR packet.
     pub ssrc: u32,
diff --git a/src/source_description/mod.rs b/src/source_description/mod.rs
diff --git a/src/transport_feedbacks/rapid_resynchronization_request/mod.rs b/src/transport_feedbacks/rapid_resynchronization_request/mod.rs
diff --git a/src/transport_feedbacks/transport_layer_cc/mod.rs b/src/transport_feedbacks/transport_layer_cc/mod.rs
diff --git a/src/transport_feedbacks/transport_layer_nack/mod.rs b/src/transport_feedbacks/transport_layer_nack/mod.rs
diff --git a/src/util.rs b/src/util.rs

Original file line number	Diff line number	Diff line change
`@@ -75,13 +75,14 @@ fn test_bad_compound() {`
`75`	`75`	`compound_len, 2`
`76`	`76`	`);`
`77`	`77`
`78`		`- if let None = compound.0[0].as_any().downcast_ref::<Goodbye>() {`
	`78`	`+ if compound.0[0].as_any().downcast_ref::<Goodbye>().is_none() {`
`79`	`79`	`panic!("Unmarshal(badcompound), want Goodbye")`
`80`	`80`	`}`
`81`	`81`
`82`		`- if let None = compound.0[1]`
	`82`	`+ if compound.0[1]`
`83`	`83`	`.as_any()`
`84`	`84`	`.downcast_ref::<PictureLossIndication>()`
	`85`	`+ .is_none()`
`85`	`86`	`{`
`86`	`87`	`panic!("Unmarshal(badcompound), want PictureLossIndication")`
`87`	`88`	`}`
`@@ -311,7 +312,7 @@ fn test_compound_packet_roundtrip() {`
`311`	`312`	`name, got, err`
`312`	`313`	`);`
`313`	`314`	`} else {`
`314`		`- assert!(false, "want error in test {}", name);`
	`315`	`+ panic!("want error in test {}", name);`
`315`	`316`	`}`
`316`	`317`	`continue;`
`317`	`318`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ const RRT_REPORT_BLOCK_LENGTH: u16 = 8;`
`14`	`14`	`/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
`15`	`15`	`/// \| NTP timestamp, least significant word \|`
`16`	`16`	`/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+`
`17`		`-#[derive(Debug, Default, PartialEq, Clone)]`
	`17`	`+#[derive(Debug, Default, PartialEq, Eq, Clone)]`
`18`	`18`	`pub struct ReceiverReferenceTimeReportBlock {`
`19`	`19`	`pub ntp_timestamp: u64,`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ use super::*;`
`2`	`2`
`3`	`3`	`/// UnknownReportBlock is used to store bytes for any report block`
`4`	`4`	`/// that has an unknown Report Block Type.`
`5`		`-#[derive(Debug, Default, PartialEq, Clone)]`
	`5`	`+#[derive(Debug, Default, PartialEq, Eq, Clone)]`
`6`	`6`	`pub struct UnknownReportBlock {`
`7`	`7`	`pub bytes: Bytes,`
`8`	`8`	`}`