refactor: Conform to api guidelines

src/entries/chunk_entry.rs

@@ -7,7 +7,7 @@ use crate::generated::rman::Chunk;
 ///
 /// [rman-schema]: https://github.com/ev3nvy/rman-schema
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-#[derive(Debug, Default, Clone, PartialEq, Eq)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub struct ChunkEntry {
     /// Id of the chunk entry.
     pub id: i64,

src/entries/key_entry.rs

@@ -7,7 +7,7 @@ use crate::generated::rman::Key;
 ///
 /// [rman-schema]: https://github.com/ev3nvy/rman-schema
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-#[derive(Debug, Default, Clone, PartialEq, Eq)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub struct KeyEntry {
     /// Field with an unknown function and type (it might also be an [`i16`]).
     pub unk0: u16,

src/entries/param_entry.rs

@@ -7,7 +7,7 @@ use crate::generated::rman::Param;
 ///
 /// [rman-schema]: https://github.com/ev3nvy/rman-schema
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-#[derive(Debug, Default, Clone, PartialEq, Eq)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub struct ParamEntry {
     /// Field with an unknown function and type (it might also be an [`i16`]).
     pub unk0: u16,

src/error.rs

@@ -9,15 +9,15 @@ pub enum ManifestError {
     /// The error was caused by a failure to seek to a desired offset.
     ///
     /// This error occurs when [`Seek`][std::io::Seek] fails.
-    #[error("Could not seek to desired position. Error: {0}")]
+    #[error("could not seek to desired position, error: {0}")]
     SeekError(std::io::Error),
     /// The error was caused by invalid magic bytes.
     ///
     /// This error occurs when the first four bytes (magic bytes) do not equal `0x52`, `0x4D`,
     /// `0x41` and `0x4E` (or `R`, `M`, `A`, `N` in ascii) respectively.
     ///
     /// Usually caused by providing a file that is not a Riot Manifest file.
-    #[error("Invalid magic bytes (expected: \"0x4E414D52\", was: \"{0:#010x}\").")]
+    #[error("invalid magic bytes (expected: \"0x4E414D52\", was: \"{0:#010x}\")")]
     InvalidMagicBytes(u32),
     /// The error was caused by invalid major version.
     ///
@@ -27,8 +27,8 @@ pub enum ManifestError {
     /// may no longer function if this happens.
     ///
     /// NOTE: The feature `version_error` must be enabled for this error to occur.
-    #[error("Unsupported major version (expected: \"2\", was: \"{0}\").")]
-    #[cfg(feature = "version_error")]
+    #[error("unsupported major version (expected: \"2\", was: \"{0}\")")]
+    #[cfg(any(feature = "version_error", doc))]
     InvalidMajor(u8),
     /// The error was caused by invalid minor version.
     ///
@@ -38,22 +38,22 @@ pub enum ManifestError {
     /// should still be functional if this happens,
     ///
     /// NOTE: The feature `version_error` must be enabled for this error to occur.
-    #[error("Unsupported minor version (expected: \"0\", was: \"{0}\").")]
-    #[cfg(feature = "version_error")]
+    #[error("unsupported minor version (expected: \"0\", was: \"{0}\")")]
+    #[cfg(any(feature = "version_error", doc))]
     InvalidMinor(u8),
     /// The error was caused by an invalid offset.
     ///
     /// This error occurs when the offset is smaller or larger than the file itself.
     ///
     /// Should never happen for official, Riot-made manifests.
-    #[error("Offset ({0}) is larger than the total file size.")]
+    #[error("offset ({0}) is larger than the total file size")]
     InvalidOffset(u32),
     /// The error was caused by compressed size being too large.
     ///
     /// This error occurs when the compressed size is larger than the file itself.
     ///
     /// Should never happen for official, Riot-made manifests.
-    #[error("Compressed size ({0}) is larger than the total file size.")]
+    #[error("compressed size ({0}) is larger than the total file size")]
     CompressedSizeTooLarge(u32),
     /// The error was caused by a failure to read or write bytes on an IO stream.
     ///
@@ -68,7 +68,7 @@ pub enum ManifestError {
     /// This error occurs when the conversion from or into [`usize`] fails.
     ///
     /// Should never fail on 32-bit (or higher) targets.
-    #[error("Conversion failed. Error: {0}")]
+    #[error("conversion failed, error: {0}")]
     ConversionFailure(#[from] std::num::TryFromIntError),
     /// The error was caused by a failure to decompress zstd data.
     ///

src/file.rs

@@ -87,7 +87,7 @@ impl File {
 
         while directory_id != 0 {
             let Some((dir_name, parent_id)) = directories.get(&directory_id) else {
-                let message = format!("Could not find a directory with the following id: \"{directory_id}\".");
+                let message = format!("could not find a directory with the following id: \"{directory_id}\"");
                 return Err(ManifestError::FileParseError(message));
             };
             path = format!("{dir_name}/{path}");
@@ -112,7 +112,7 @@ impl File {
 
         for chunk_id in chunk_ids {
             let Some(chunk) = chunk_entries.get(chunk_id) else {
-                let message = format!("Could not find a chunk with the following id: \"{chunk_id}\".");
+                let message = format!("could not find a chunk with the following id: \"{chunk_id}\"");
                 return Err(ManifestError::FileParseError(message));
             };
             chunks.push(chunk.to_owned());

src/lib.rs

@@ -1,5 +1,5 @@
 #![deny(missing_docs)]
-#![deny(missing_debug_implementations)]
+#![deny(missing_debug_implementations, missing_copy_implementations)]
 #![deny(clippy::all, clippy::pedantic, clippy::nursery, clippy::unwrap_used)]
 #![allow(clippy::module_name_repetitions, clippy::similar_names)]
 
@@ -30,15 +30,19 @@
 //! internally, so everything from [`&str`][str] to [`PathBuf`][std::path::PathBuf] is a valid
 //! argument.
 //!
-//! ```
+//! ```rust
+//! # use rman::Result;
 //! use rman::RiotManifest;
 //!
+//! # fn main() -> Result<()> {
 //! let path = "file.manifest";
-//! # let path = concat!(env!("OUT_DIR"), "/valid.manifest");
+//!   # let path = concat!(env!("OUT_DIR"), "/valid.manifest");
 //!
-//! let manifest = RiotManifest::from_path(path).unwrap();
+//! let manifest = RiotManifest::from_path(path)?;
 //!
 //! assert_eq!(manifest.data.files.len(), 1);
+//!   # Ok(())
+//! # }
 //! ```
 //!
 //! # Example: parsing a manifest file from reader
@@ -49,28 +53,32 @@
 //! Internally, this is what [`from_path`](crate::RiotManifest::from_path) calls, so the response
 //! of the two functions should be identical.
 //!
-//! ```
+//! ```rust
 //! use std::fs;
 //! use std::io::BufReader;
 //!
+//! # use rman::Result;
 //! use rman::RiotManifest;
 //!
+//! # fn main() -> Result<()> {
 //! let path = "file.manifest";
-//! # let path = concat!(env!("OUT_DIR"), "/valid.manifest");
-//! let file = fs::File::open(path).unwrap();
+//!   # let path = concat!(env!("OUT_DIR"), "/valid.manifest");
+//! let file = fs::File::open(path)?;
 //! let mut reader = BufReader::new(file);
 //!
-//! let manifest = RiotManifest::from_reader(&mut reader).unwrap();
+//! let manifest = RiotManifest::from_reader(&mut reader)?;
 //!
 //! assert_eq!(manifest.data.files.len(), 1);
+//!   # Ok(())
+//! # }
 //! ```
 //!
 //! # Example: downloading a file
 //!
 //! To download a specific file from a parsed manifest, you can invoke the
 //! [download function](crate::File::download) on that [file][crate::File].
 //!
-//! ```
+//! ```rust
 //! use std::fs;
 //!
 //! # use httptest::{matchers::*, responders::*, Expectation, Server};
@@ -168,8 +176,9 @@ mod file;
 mod parser;
 
 mod generated {
+    #![allow(warnings)]
+    #![allow(missing_debug_implementations, missing_copy_implementations)]
     #![allow(clippy::all, clippy::pedantic, clippy::nursery, clippy::unwrap_used)]
-    #![allow(missing_debug_implementations, unused_imports)]
     include!(concat!(env!("OUT_DIR"), "/schema_generated.rs"));
 }
 

src/parser.rs

@@ -49,10 +49,7 @@ impl RiotManifest {
     /// [parsing a manifest file from path](index.html#example-parsing-a-manifest-file-from-path).
     ///
     /// [`RiotManifest::from_reader`]: crate::RiotManifest::from_reader
-    pub fn from_path<P>(path: P) -> Result<Self>
-    where
-        P: AsRef<Path>,
-    {
+    pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self> {
         let file = fs::File::open(path)?;
         let mut reader = BufReader::new(file);
         Self::from_reader(&mut reader)
@@ -90,11 +87,8 @@ impl RiotManifest {
     /// [`ManifestData::parse`][crate::ManifestData::parse].
     ///
     /// [flatbuffer binary]: https://github.com/ev3nvy/rman-schema
-    pub fn from_reader<R>(reader: &mut R) -> Result<Self>
-    where
-        R: Read + Seek,
-    {
-        let header = Header::from_reader(reader)?;
+    pub fn from_reader<R: Read + Seek>(mut reader: R) -> Result<Self> {
+        let header = Header::from_reader(&mut reader)?;
 
         if let Err(error) = reader.seek(SeekFrom::Start(header.offset.into())) {
             return Err(ManifestError::SeekError(error));

src/parser/header.rs

@@ -1,3 +1,4 @@
+use std::borrow::BorrowMut;
 use std::io::{Read, Seek};
 
 use byteorder::{ReadBytesExt, LE};
@@ -74,12 +75,9 @@ impl Header {
     /// If [`compressed_size`](Header::compressed_size) is smaller or larger than the file, the
     /// error [`CompressedSizeTooLarge`][crate::ManifestError::CompressedSizeTooLarge] is
     /// returned.
-    pub fn from_reader<R>(reader: &mut R) -> Result<Self>
-    where
-        R: Read + Seek,
-    {
+    pub fn from_reader<R: Read + Seek>(mut reader: R) -> Result<Self> {
         debug!("Attempting to convert \"reader.bytes().count()\" into \"u32\".");
-        let size: u32 = reader.bytes().count().try_into()?;
+        let size: u32 = reader.borrow_mut().bytes().count().try_into()?;
         debug!("Successfully converted \"reader.bytes().count()\" into \"u32\".");
 
         debug!("The file is {size} bytes in size");