Crate linter attributes

.github/workflows/pre-commit.yml

@@ -13,6 +13,11 @@ jobs:
       with:
         fetch-depth: 2
 
+    - name: Generate Cargo.lock
+      uses: actions-rs/cargo@v1
+      with:
+        command: generate-lockfile
+
     - name: Set up Python
       uses: actions/setup-python@v2
 

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_language_version:
   python: python3
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.0.1
+  rev: v4.1.0
   hooks:
   - id: check-case-conflict
   - id: check-json
@@ -19,11 +19,14 @@ repos:
   - id: fix-byte-order-marker
   - id: forbid-new-submodules
   - id: mixed-line-ending
+  - id: trailing-whitespace
 - repo: https://github.com/codespell-project/codespell
   rev: v2.1.0
   hooks:
   - id: codespell
-    args: [ --ignore-words=.codespellignore ]
+    args: [
+      --ignore-words=.codespellignore
+    ]
 - repo: https://github.com/doublify/pre-commit-rust
   rev: v1.0
   hooks:

Cargo.toml

@@ -16,5 +16,5 @@ base64 = "0.13"
 thiserror = "1"
 
 [dev-dependencies]
-id3 = "0.6"
+id3 = "1"
 textwrap = "0.14"

src/error.rs

@@ -1,8 +1,5 @@
 //! Error types and helper functions.
 
-extern crate base64;
-extern crate thiserror;
-
 /// Error enumerates all possible errors returned by this library.
 #[derive(thiserror::Error, Debug)]
 pub enum Error {

src/lib.rs

@@ -102,6 +102,22 @@
 //! possible, but since this feature is still under development, the API is *not* stable yet and
 //! might change in the future.
 
+#![warn(unsafe_code)]
+#![cfg_attr(not(debug_assertions), deny(warnings))]
+#![deny(rust_2018_idioms)]
+#![deny(rust_2021_compatibility)]
+#![deny(missing_debug_implementations)]
+// TODO: Add missing docs
+//#![deny(missing_docs)]
+#![deny(rustdoc::broken_intra_doc_links)]
+#![deny(clippy::all)]
+#![deny(clippy::explicit_deref_methods)]
+#![deny(clippy::explicit_into_iter_loop)]
+#![deny(clippy::explicit_iter_loop)]
+#![deny(clippy::must_use_candidate)]
+#![cfg_attr(not(test), deny(clippy::panic_in_result_fn))]
+#![cfg_attr(not(debug_assertions), deny(clippy::used_underscore_binding))]
+
 pub mod error;
 pub mod library;
 pub mod tag;

src/library/database.rs

@@ -1,5 +1,3 @@
-extern crate nom;
-
 use crate::error::Error;
 use crate::util::Res;
 use std::path::PathBuf;

src/library/parser.rs

@@ -49,6 +49,7 @@ pub struct Track {
 
 impl Track {
     /// Creates a new, empty Track object.
+    #[must_use]
     pub fn new() -> Self {
         Self {
             file_type: None,
@@ -120,14 +121,15 @@ impl Default for Track {
 }
 
 /// DAO that reads Serato libraries from the file system.
+#[derive(Debug, Clone)]
 pub struct Library {
     path: PathBuf,
     tracks: HashMap<PathBuf, Track>,
 }
 
 impl Library {
     /// Read the library in the given path.
-    pub fn read_from_path(path: impl AsRef<Path>) -> Result<Self, Error> {
+    pub fn read_from_path_ref(path: &Path) -> Result<Self, Error> {
         let path = fs::canonicalize(path)?;
         let tracks = HashMap::new();
         let mut library = Library { path, tracks };
@@ -136,6 +138,14 @@ impl Library {
         Ok(library)
     }
 
+    /// Read the library in the given path.
+    ///
+    /// Convenience function that accepts anything that could be
+    /// converted into a `Path` reference.
+    pub fn read_from_path(path: impl AsRef<Path>) -> Result<Self, Error> {
+        Self::read_from_path_ref(path.as_ref())
+    }
+
     fn serato_path(&self) -> PathBuf {
         self.path.join(SERATO_DIR)
     }
@@ -148,7 +158,7 @@ impl Library {
         file.read_to_end(&mut data)?;
 
         let fields = database::parse(&data)?;
-        let tracks: Result<HashMap<_, _>, Error> = fields
+        self.tracks = fields
             .into_iter()
             .filter_map(|field| {
                 if let database::Field::Track(t) = field {
@@ -158,8 +168,7 @@ impl Library {
                 }
             })
             .map(Track::from_fields)
-            .collect();
-        self.tracks = tracks?;
+            .collect::<Result<HashMap<_, _>, _>>()?;
 
         Ok(())
     }
@@ -170,6 +179,7 @@ impl Library {
     }
 
     /// Get the track struct for the given path.
+    #[must_use]
     pub fn track(&self, file_path: &Path) -> Option<&Track> {
         self.tracks.get(file_path)
     }

src/tag/autotags.rs

@@ -27,7 +27,7 @@ use std::io;
 ///     println!("{:?}", content);
 /// }
 /// ```
-#[derive(Debug)]
+#[derive(Debug, Clone, Copy)]
 pub struct Autotags {
     /// The tag version.
     pub version: Version,

src/tag/beatgrid.rs

@@ -11,7 +11,7 @@ use std::io;
 ///
 /// The last beatgrid marker always has to be a terminal one. This is also the case if the tag only
 /// contains a single beatgrid marker.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct TerminalMarker {
     /// The position in seconds.
     pub position: f32,
@@ -22,7 +22,7 @@ pub struct TerminalMarker {
 /// Represents a non-terminal beatgrid marker in the `Serato BeatGrid` tag.
 ///
 /// All beatgrid markers before the last one are non-terminal beatgrid markers.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct NonTerminalMarker {
     /// The position in seconds.
     pub position: f32,
@@ -47,7 +47,7 @@ pub struct NonTerminalMarker {
 ///     println!("{:?}", content);
 /// }
 /// ```
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct Beatgrid {
     /// The analysis version.
     pub version: Version,

src/tag/color.rs

@@ -118,6 +118,7 @@ impl Color {
     ///
     /// assert_eq!(non_pro_color, Color { red: 0xC0, green: 0xFF, blue: 0xEE });
     /// ```
+    #[must_use]
     pub fn into_pro_hotcue_color(self) -> Self {
         if let Some(index) = HOTCUE_COLORS_INTRO.iter().position(|&x| x == self) {
             return HOTCUE_COLORS_PRO[index];
@@ -151,6 +152,7 @@ impl Color {
     ///
     /// assert_eq!(non_intro_color, Color { red: 0xC0, green: 0xFF, blue: 0xEE });
     /// ```
+    #[must_use]
     pub fn into_intro_hotcue_color(self) -> Self {
         if let Some(index) = HOTCUE_COLORS_PRO.iter().position(|&x| x == self) {
             return HOTCUE_COLORS_INTRO[index];
@@ -176,6 +178,7 @@ impl Color {
     /// let displayed_color = stored_color.into_displayed_track_color();
     /// assert_eq!(displayed_color, None);
     /// ```
+    #[must_use]
     pub fn into_displayed_track_color(self) -> Option<Self> {
         match self {
             Color {
@@ -205,6 +208,7 @@ impl Color {
     /// let stored_color = Color::from_displayed_track_color(None);
     /// assert_eq!(stored_color, Color { red: 0xFF, green: 0xFF, blue: 0xFF });
     /// ```
+    #[must_use]
     pub fn from_displayed_track_color(color: Option<Self>) -> Self {
         let code: u32 = match color {
             Some(color) => color.into(),

src/tag/container.rs

@@ -14,6 +14,7 @@ use std::io;
 ///
 /// Some of the data in Serato's tags is redundant and may contradict each other. This class
 /// implements the same merge strategies for inconsistent data that Serato uses, too.
+#[derive(Debug, Clone)]
 pub struct TagContainer {
     autotags: Option<Autotags>,
     beatgrid: Option<Beatgrid>,
@@ -26,6 +27,7 @@ pub struct TagContainer {
 ///
 /// The format of the Serato tag data differs between tag types.
 /// Therefore it's necessary to tell the parser from what kind of the the data originates from.
+#[derive(Debug, Clone, Copy)]
 pub enum TagFormat {
     ID3,
     FLAC,
@@ -35,7 +37,8 @@ pub enum TagFormat {
 
 impl TagContainer {
     /// Create an empty Serato tag container.
-    pub fn new() -> Self {
+    #[must_use]
+    pub const fn new() -> Self {
         Self {
             autotags: None,
             beatgrid: None,
@@ -219,6 +222,7 @@ impl TagContainer {
     }
 
     /// Returns the [`auto_gain`](Autotags::auto_gain) value from the [`Serato Autotags`](Autotags) tag.
+    #[must_use]
     pub fn auto_gain(&self) -> Option<f64> {
         if let Some(tag) = &self.autotags {
             return Some(tag.auto_gain);
@@ -228,6 +232,7 @@ impl TagContainer {
     }
 
     /// Returns the [`gain_db`](Autotags::gain_db) value from the [`Serato Autotags`](Autotags) tag.
+    #[must_use]
     pub fn gain_db(&self) -> Option<f64> {
         if let Some(tag) = &self.autotags {
             return Some(tag.gain_db);
@@ -237,6 +242,7 @@ impl TagContainer {
     }
 
     /// Returns the beatgrid from the [`Serato BeatGrid`](Beatgrid) tag.
+    #[must_use]
     pub fn beatgrid(
         &self,
     ) -> Option<(&Vec<beatgrid::NonTerminalMarker>, &beatgrid::TerminalMarker)> {
@@ -248,6 +254,7 @@ impl TagContainer {
     }
 
     /// Returns BPM lock status from the [`Serato Markers2`](Markers2) tag.
+    #[must_use]
     pub fn bpm_locked(&self) -> Option<bool> {
         if let Some(m) = &self.markers2 {
             return m.bpm_locked();
@@ -261,6 +268,7 @@ impl TagContainer {
     /// This retrieves the `Serato Markers2` cues first, then overwrite the values with those from
     /// `Serato Markers_`. This is what Serato does too (i.e. if `Serato Markers_` and `Serato
     /// Markers2` contradict each other, Serato will use the values from `Serato Markers_`).
+    #[must_use]
     pub fn cues(&self) -> Vec<generic::Cue> {
         let mut map = std::collections::BTreeMap::new();
 
@@ -325,6 +333,7 @@ impl TagContainer {
     /// This retrieves the `Serato Markers2` loops first, then overwrite the values with those from
     /// `Serato Markers_`. This is what Serato does too (i.e. if `Serato Markers_` and `Serato
     /// Markers2` contradict each other, Serato will use the values from `Serato Markers_`).
+    #[must_use]
     pub fn loops(&self) -> Vec<generic::Loop> {
         let mut map = std::collections::BTreeMap::new();
 
@@ -394,6 +403,7 @@ impl TagContainer {
     /// `Serato Markers2`. This is what Serato does too, i.e. if `Serato Markers_`
     /// and `Serato Markers2` contradict each other, Serato will use the value
     /// from `Serato Markers_`.
+    #[must_use]
     pub fn track_color(&self) -> Option<Color> {
         self.markers
             .as_ref()
@@ -402,6 +412,7 @@ impl TagContainer {
     }
 
     /// Returns the waveform overview data color from the [`Serato Overview`](Overview) tag.
+    #[must_use]
     pub fn overview_data(&self) -> Option<&[Vec<u8>]> {
         self.overview.as_ref().map(|overview| &overview.data[..])
     }

src/tag/format/enveloped.rs

@@ -1,6 +1,4 @@
 //! Helper for FLAC and MP4 tags
-extern crate base64;
-extern crate nom;
 
 use super::Tag;
 use crate::error::Error;
@@ -29,10 +27,12 @@ pub fn parse_envelope(input: &[u8]) -> Result<(&str, &[u8]), Error> {
     Ok((name, input))
 }
 
+#[must_use]
 pub fn is_base64(byte: u8) -> bool {
     byte.is_ascii_alphanumeric() || byte == b'+' || byte == b'/' || byte == b'='
 }
 
+#[must_use]
 pub fn is_newline(byte: u8) -> bool {
     byte == b'\n'
 }

src/tag/format/flac.rs

@@ -1,6 +1,4 @@
 //! FLAC tags
-extern crate base64;
-extern crate nom;
 
 use super::enveloped::EnvelopedTag;
 use crate::error::Error;

src/tag/format/mp4.rs

@@ -1,8 +1,5 @@
 //! MP4 tags
 
-extern crate base64;
-extern crate nom;
-
 use super::enveloped::EnvelopedTag;
 use crate::error::Error;
 use std::io;

src/tag/markers.rs

@@ -16,7 +16,7 @@ use std::io;
 use std::io::Cursor;
 
 /// Represents a single marker in the `Serato Markers_` tag.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct Marker {
     /// The position of the loop or cue.
     pub start_position: Option<Position>,
@@ -57,7 +57,7 @@ pub struct Marker {
 ///     println!("{:?}", content);
 /// }
 /// ```
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct Markers {
     /// The tag version.
     pub version: Version,
@@ -70,6 +70,7 @@ pub struct Markers {
 }
 
 impl Markers {
+    #[must_use]
     pub fn cues(&self) -> Vec<(u8, &Marker)> {
         let mut index: u8 = 0;
         let mut cues = Vec::new();
@@ -84,6 +85,7 @@ impl Markers {
         cues
     }
 
+    #[must_use]
     pub fn loops(&self) -> Vec<(u8, &Marker)> {
         let mut index: u8 = 0;
         let mut loops = Vec::new();
@@ -98,6 +100,7 @@ impl Markers {
         loops
     }
 
+    #[must_use]
     pub fn track_color(&self) -> Color {
         self.track_color
     }