Add is_sorted() implementation.

Note: This requires bumping the MSRV to 1.82.0.

Author: ctamblyn

Cargo.toml

@@ -9,6 +9,6 @@ documentation = "https://docs.rs/bit-iter"
 repository = "https://github.com/ctamblyn/bit-iter"
 keywords = ["bits", "flags", "iterator", "bit-twiddling"]
 categories = ["algorithms", "no-std"]
-rust-version = "1.53.0"
+rust-version = "1.82.0"
 
 [dependencies]

README.md

@@ -44,7 +44,7 @@ Bit 0 is set.
 
 ## Minimum supported Rust version (MSRV) policy
 
-`bit-iter`'s current minimum supported Rust version (MSRV) is **1.53.0**.
+`bit-iter`'s current minimum supported Rust version (MSRV) is **1.82.0**.
 
 `bit-iter` is guaranteed to compile with that version.  It might also compile
 with older versions, but that could change in a future patch release.

clippy.toml

@@ -1 +1 @@
-msrv = "1.53.0"
+msrv = "1.82.0"

src/lib.rs

@@ -181,6 +181,10 @@ macro_rules! iter_impl {
                     None
                 }
             }
+
+            fn is_sorted(self) -> bool {
+                true
+            }
         }
 
         /// `FusedIterator` implementation for `BitIter`.

src/tests.rs

@@ -139,3 +139,21 @@ fn can_iterate_in_reverse_order() {
     assert_eq!(iter.next(), Some(0));
     assert_eq!(iter.next(), None);
 }
+
+#[test]
+fn is_sorted_works() {
+    let iter = BitIter::from(0x55_u8);
+    assert!(iter.is_sorted());
+
+    let iter = BitIter::from(0x5555_u16);
+    assert!(iter.is_sorted());
+
+    let iter = BitIter::from(0x55555555_u32);
+    assert!(iter.is_sorted());
+
+    let iter = BitIter::from(0x5555555555555555_u64);
+    assert!(iter.is_sorted());
+
+    let iter = BitIter::from(0x55555555555555555555555555555555_u128);
+    assert!(iter.is_sorted());
+}