Fix clippy warnings about elided lifetimes and some rustdoc issues.

Bump the version
Simplify some of the BooleanVector equality tests

Author: jgerrish

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "image-rider"
-version = "0.10.1"
+version = "0.10.2"
 edition = "2021"
 authors = ["Joshua Gerrish <jgerrish@gmail.com>"]
 description = "Disk image and ROM image parser"

src/disk_format/apple/catalog.rs

@@ -186,7 +186,7 @@ impl<'a> Serializer<'a> for TrackSectorList<'a> {
 pub type TrackSectorLists<'a> = Vec<TrackSectorList<'a>>;
 
 /// Parse a track / sector list.
-pub fn parse_track_sector_list(i: &[u8]) -> IResult<&[u8], TrackSectorList> {
+pub fn parse_track_sector_list(i: &[u8]) -> IResult<&[u8], TrackSectorList<'_>> {
     let mut track_sector_pairs: Vec<TrackSectorPair> = Vec::new();
 
     let (i, reserved) = le_u8(i)?;
@@ -315,7 +315,7 @@ impl<'a> FileEntry<'a> {
         locked: bool,
         filename: &str,
         file_length_in_sectors: u16,
-    ) -> FileEntry {
+    ) -> FileEntry<'_> {
         FileEntry {
             track_of_first_track_sector_list_sector,
             sector_of_first_track_sector_list_sector,
@@ -530,7 +530,7 @@ impl Display for FileEntry<'_> {
 }
 
 /// Parse a file entry
-pub fn parse_file_entry(i: &[u8]) -> IResult<&[u8], FileEntry> {
+pub fn parse_file_entry(i: &[u8]) -> IResult<&[u8], FileEntry<'_>> {
     let (i, track_of_first_track_sector_list_sector) = le_u8(i)?;
     let (i, sector_of_first_track_sector_list_sector) = le_u8(i)?;
 
@@ -657,7 +657,7 @@ pub fn valid_file(track_of_first_track_sector_list_sector: u8) -> bool {
 }
 
 /// Parse an Apple ][ DOS disk catalog
-pub fn parse_catalog(i: &[u8]) -> IResult<&[u8], Catalog> {
+pub fn parse_catalog(i: &[u8]) -> IResult<&[u8], Catalog<'_>> {
     let (i, reserved) = le_u8(i)?;
     let (i, track_number_of_next_sector) = le_u8(i)?;
     let (i, sector_number_of_next_sector) = le_u8(i)?;
@@ -1510,8 +1510,7 @@ mod tests {
             track_number: 0x11,
             sector_number: 0x0B,
         };
-        let mut tsps: TrackSectorPairs = Vec::new();
-        tsps.push(tsp);
+        let tsps: TrackSectorPairs = vec![tsp];
 
         let tsl = TrackSectorList {
             reserved: 0,
@@ -1618,9 +1617,7 @@ mod tests {
             track_number: 0x11,
             sector_number: 0x0C,
         };
-        let mut tsps: TrackSectorPairs = Vec::new();
-        tsps.push(tsp1);
-        tsps.push(tsp2);
+        let tsps: TrackSectorPairs = vec![tsp1, tsp2];
 
         let tsl = TrackSectorList {
             reserved: 0,

src/disk_format/apple/disk.rs

@@ -160,7 +160,7 @@ impl Display for VolumeTableOfContents<'_> {
 }
 
 /// Parse a Volume Table of Contents
-pub fn parse_volume_table_of_contents(i: &[u8]) -> IResult<&[u8], VolumeTableOfContents> {
+pub fn parse_volume_table_of_contents(i: &[u8]) -> IResult<&[u8], VolumeTableOfContents<'_>> {
     let (i, reserved) = le_u8(i)?;
     let (i, track_number_of_first_catalog_sector) = le_u8(i)?;
     let (i, sector_number_of_first_catalog_sector) = le_u8(i)?;
@@ -431,7 +431,7 @@ impl<'a, 'b> DiskImageGuesser<'a, 'b> for AppleDiskGuess<'a> {
 ///
 /// There was a design decision here to return None as opposed to an
 /// Unknown Apple image type.  I don't know if it's the right choice.
-pub fn format_from_data(data: &[u8]) -> std::result::Result<Option<DiskImageGuess>, Error> {
+pub fn format_from_data(data: &[u8]) -> std::result::Result<Option<DiskImageGuess<'_>>, Error> {
     let filesize: u64 = data.len().try_into().unwrap();
 
     info!("Reading magic number from file");
@@ -700,6 +700,7 @@ mod tests {
         let path = Path::new(&filename);
         let mut file = OpenOptions::new()
             .create(true)
+            .truncate(true)
             .write(true)
             .open(path)
             .unwrap_or_else(|e| {
@@ -847,7 +848,7 @@ mod tests {
         data.extend(data_vtoc);
         data.extend(data_suffix);
 
-        std::fs::write(&path, &data).unwrap_or_else(|e| {
+        std::fs::write(path, &data).unwrap_or_else(|e| {
             panic!("Error writing test file: {}", e);
         });
 
@@ -903,7 +904,7 @@ mod tests {
          * saving it to version control */
         let path = Path::new(&filename);
         let data: [u8; 143360] = [0; 143360];
-        std::fs::write(&path, data).unwrap_or_else(|e| {
+        std::fs::write(path, data).unwrap_or_else(|e| {
             panic!("Error writing test file: {}", e);
         });
 

src/disk_format/apple/nibble.rs

@@ -648,7 +648,8 @@ mod tests {
         let mut data: [u8; 342] = [0; 342];
 
         for i in 0..=341 {
-            data[i] = NIBBLE_WRITE_TABLE_6_AND_2[(i % 0x40) as usize];
+            // data[i] = NIBBLE_WRITE_TABLE_6_AND_2[(i % 0x40) as usize];
+            data[i] = NIBBLE_WRITE_TABLE_6_AND_2[i % 0x40];
         }
 
         let data_field = DataField {

src/disk_format/commodore/d64.rs

@@ -701,7 +701,7 @@ impl DiskImageSaver for D64Disk<'_> {
 mod tests {
     use super::{
         bam_entry_parser, bam_entry_to_boolean_vector, bitmap_to_chars, d64_file_entry_parser,
-        FileType,
+        BooleanVector, FileType,
     };
     use crate::config::Configuration;
 
@@ -721,29 +721,13 @@ mod tests {
         let bv = bam_entry_to_boolean_vector(&bam_entry.1);
 
         assert_eq!(bv.0.len(), 21);
-        assert_eq!(bv.0[0], true);
-        assert_eq!(bv.0[1], true);
-        assert_eq!(bv.0[2], true);
-        assert_eq!(bv.0[3], false);
-        assert_eq!(bv.0[4], true);
-        assert_eq!(bv.0[5], false);
-        assert_eq!(bv.0[6], true);
-        assert_eq!(bv.0[7], true);
-
-        assert_eq!(bv.0[8], true);
-        assert_eq!(bv.0[9], true);
-        assert_eq!(bv.0[10], true);
-        assert_eq!(bv.0[11], true);
-        assert_eq!(bv.0[12], true);
-        assert_eq!(bv.0[13], false);
-        assert_eq!(bv.0[14], true);
-        assert_eq!(bv.0[15], false);
-
-        assert_eq!(bv.0[16], true);
-        assert_eq!(bv.0[17], true);
-        assert_eq!(bv.0[18], true);
-        assert_eq!(bv.0[19], true);
-        assert_eq!(bv.0[20], true);
+        assert_eq!(
+            bv,
+            BooleanVector(vec![
+                true, true, true, false, true, false, true, true, true, true, true, true, true,
+                false, true, false, true, true, true, true, true
+            ])
+        );
     }
 
     /// Test parsing STX boot sector checksum
@@ -787,10 +771,7 @@ mod tests {
             })
             .1;
 
-        assert_eq!(
-            FileType::from(file_entry.file_type.file_type),
-            FileType::Program
-        );
+        assert_eq!(file_entry.file_type.file_type, FileType::Program);
 
         // assert_eq!(file_entry_program.file_type, 0x82);
     }

src/disk_format/image.rs

@@ -556,7 +556,7 @@ pub fn format_from_filename_and_data<'a>(
 }
 
 /// Function to collect the actual disk image data from a disk image and return
-/// it as an Option<Vec<u8>>
+/// it as an `Option<Vec<u8>>`
 /// It should have more tests around the different disk types
 pub fn disk_image_data(disk_image: &DiskImage) -> Option<Vec<u8>> {
     match disk_image {
@@ -601,6 +601,7 @@ mod tests {
         let path = Path::new(&filename);
         let mut file = OpenOptions::new()
             .create(true)
+            .truncate(true)
             .write(true)
             .open(path)
             .unwrap_or_else(|e| {

src/disk_format/stx/disk.rs

@@ -137,7 +137,7 @@ impl Display for STXDiskHeader<'_> {
 
 /// The track or sector image data can be located in several places, depending on the
 /// fuzzy masks and track flags
-pub fn stx_disk_parser(i: &[u8]) -> IResult<&[u8], STXDisk> {
+pub fn stx_disk_parser(i: &[u8]) -> IResult<&[u8], STXDisk<'_>> {
     let (i, stx_disk_header) = stx_disk_header_parser(i)?;
 
     if !stx_disk_header.check() {
@@ -159,7 +159,7 @@ pub fn stx_disk_parser(i: &[u8]) -> IResult<&[u8], STXDisk> {
 
 // TODO: Verify that this is reading correctly
 /// Parse STX disks
-pub fn stx_disk_header_parser(i: &[u8]) -> IResult<&[u8], STXDiskHeader> {
+pub fn stx_disk_header_parser(i: &[u8]) -> IResult<&[u8], STXDiskHeader<'_>> {
     // will consume bytes if the input begins with "RSY" + 0
     // magic number
     let (i, disk_id) = tag("RSY\0")(i)?;

src/disk_format/stx/sector.rs

@@ -263,7 +263,7 @@ impl Display for STXSyncMarker<'_> {
 }
 
 /// Read in the four sync markers at the start of the track image data
-pub fn stx_sync_markers_parser(i: &[u8]) -> IResult<&[u8], STXSyncMarker> {
+pub fn stx_sync_markers_parser(i: &[u8]) -> IResult<&[u8], STXSyncMarker<'_>> {
     let (i, stx_sync_markers) = take(4_usize)(i)?;
 
     Ok((
@@ -335,9 +335,11 @@ mod tests {
 
         // equivalent to: for i in 0..256 { ... sector_data[i] }
         // for item in sector_data.iter().take(256) {
+        // for i in 0..512 {
+        // boot_sector[i] = (i & 0x00FF) as u8;
 
-        for i in 0..512 {
-            boot_sector[i] = (i & 0x00FF) as u8;
+        for (i, bs_byte) in boot_sector.iter_mut().enumerate() {
+            *bs_byte = (i & 0x00FF) as u8;
         }
 
         let words_result = parse_boot_sector_as_words(&boot_sector);
@@ -372,6 +374,6 @@ mod tests {
 
         let checksum = calculate_boot_sector_sum_from_words(&boot_sector);
 
-        assert_eq!(checksum, true);
+        assert!(checksum);
     }
 }

src/disk_format/stx/track.rs

@@ -184,7 +184,7 @@ impl Display for STXTrack<'_> {
 /// TODO: Implement full parsing
 /// This currently doesn't parse track data, just the headers
 /// TODO: Simplify this parser
-pub fn stx_track_parser(i: &[u8]) -> IResult<&[u8], STXTrack> {
+pub fn stx_track_parser(i: &[u8]) -> IResult<&[u8], STXTrack<'_>> {
     // Record the starting position so we can figure out how much was missed
     let starting_position = i;
     let stx_track_header_result = stx_track_header_parser(i)?;
@@ -403,7 +403,7 @@ mod tests {
                 assert_eq!(res.record_type, 0x00);
 
                 // Should fail because of the flags
-                assert_eq!(false, res.check());
+                assert!(!res.check());
             }
             Err(e) => panic!("Parsing failed on the STX disk header: {}", e),
         }

src/file.rs

@@ -21,6 +21,7 @@ use crate::error::Error;
 ///
 /// # Examples
 ///
+/// ```
 /// // Start of setup code
 /// use std::path::Path;
 /// use std::io::{Read, Write};