Deny missing docs (#36)

src/decoder.rs

@@ -36,8 +36,12 @@ pub enum DecodingError {
     ChunkHeaderInvalid([u8; 4]),
 
     /// Some bits were invalid
-    #[error("Invalid info bits: {name} {value}")]
-    InfoBitsInvalid { name: &'static str, value: u32 },
+    #[error("Reserved bits set")]
+    ReservedBitSet,
+
+    /// Invalid compression method
+    #[error("Invalid compression method")]
+    InvalidCompressionMethod,
 
     /// Alpha chunk doesn't match the frame's size
     #[error("Alpha chunk size mismatch")]
@@ -59,6 +63,7 @@ pub enum DecodingError {
     #[error("Invalid lossless version number: {0}")]
     VersionNumberInvalid(u8),
 
+    /// Invalid color cache bits
     #[error("Invalid color cache bits: {0}")]
     InvalidColorCacheBits(u8),
 
@@ -634,10 +639,7 @@ impl<R: Read + Seek> WebPDecoder<R> {
         let frame_info = self.r.read_u8()?;
         let reserved = frame_info & 0b11111100;
         if reserved != 0 {
-            return Err(DecodingError::InfoBitsInvalid {
-                name: "reserved",
-                value: reserved.into(),
-            });
+            return Err(DecodingError::ReservedBitSet);
         }
         let use_alpha_blending = frame_info & 0b00000010 == 0;
         let dispose = frame_info & 0b00000001 != 0;

src/extended.rs

@@ -214,17 +214,7 @@ pub(crate) fn read_extended_header<R: Read>(
     let reserved_third = read_3_bytes(reader)?;
 
     if reserved_first != 0 || reserved_second != 0 || reserved_third != 0 {
-        let value: u32 = if reserved_first != 0 {
-            reserved_first.into()
-        } else if reserved_second != 0 {
-            reserved_second.into()
-        } else {
-            reserved_third
-        };
-        return Err(DecodingError::InfoBitsInvalid {
-            name: "reserved",
-            value,
-        });
+        return Err(DecodingError::ReservedBitSet);
     }
 
     let canvas_width = read_3_bytes(reader)? + 1;
@@ -285,21 +275,13 @@ pub(crate) fn read_alpha_chunk<R: Read>(
     let compression = info_byte & 0b00000011;
 
     if reserved != 0 {
-        return Err(DecodingError::InfoBitsInvalid {
-            name: "reserved",
-            value: reserved.into(),
-        });
+        return Err(DecodingError::ReservedBitSet);
     }
 
     let preprocessing = match preprocessing {
         0 => false,
         1 => true,
-        _ => {
-            return Err(DecodingError::InfoBitsInvalid {
-                name: "reserved",
-                value: preprocessing.into(),
-            })
-        }
+        _ => return Err(DecodingError::ReservedBitSet),
     };
 
     let filtering_method = match filtering {
@@ -313,12 +295,7 @@ pub(crate) fn read_alpha_chunk<R: Read>(
     let lossless_compression = match compression {
         0 => false,
         1 => true,
-        _ => {
-            return Err(DecodingError::InfoBitsInvalid {
-                name: "lossless compression",
-                value: compression.into(),
-            })
-        }
+        _ => return Err(DecodingError::InvalidCompressionMethod),
     };
 
     let mut framedata = Vec::new();

src/lib.rs

@@ -1,6 +1,7 @@
 //! Decoding and Encoding of WebP Images
 
 #![forbid(unsafe_code)]
+#![deny(missing_docs)]
 
 pub use self::decoder::{DecodingError, WebPDecoder};