Fixed BufferSize::try_from returning incorrect values for 4, 8, and 16 KB.

Author: newAM

.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 on:
   push:
+    branches:
+      - main
+    tags:
+      - 'v*'
   pull_request:
   schedule:
     - cron: "13 3 * * *"

.gitignore

@@ -1,2 +1,3 @@
 /target
 Cargo.lock
+tarpaulin-report.html

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.8.0] - 2021-05-08
 ### Added
 - Added `Display` for `SocketInterruptMask`.
 - Added `Display` for `SocketMode`.
@@ -13,6 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Changed the display formatting for `LinkStatus` and `SocketInterrupt`.
 
+### Fixed
+- Fixed `BufferSize::try_from` returning incorrect values for 4, 8, and 16 KB.
+
 ## [0.7.0] - 2021-02-23
 ### Changed
 - Updated `defmt` dependency from 0.1.3 to 0.2.0.
@@ -107,7 +110,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2021-01-02
 - Initial release
 
-[Unreleased]: https://github.com/newAM/w5500-ll-rs/compare/v0.7.0...HEAD
+[Unreleased]: https://github.com/newAM/w5500-ll-rs/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/newAM/w5500-ll-rs/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/newAM/w5500-ll-rs/compare/v0.6.2...v0.7.0
 [0.6.2]: https://github.com/newAM/w5500-ll-rs/compare/v0.6.1...v0.6.2
 [0.6.1]: https://github.com/newAM/w5500-ll-rs/compare/v0.6.0...v0.6.1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "w5500-ll"
-version = "0.7.0"
+version = "0.8.0"
 authors = ["Alex M. <[email protected]>"]
 edition = "2018"
 repository = "https://github.com/newAM/w5500-ll-rs"
@@ -22,12 +22,12 @@ version = "~0.2.4"
 optional = true
 
 [dependencies.defmt]
-version = "~0.2.0"
+version = "~0.2"
 optional = true
 
 [dev-dependencies]
 embedded-hal-mock = "~0.7"
-version-sync = "~0.9.1"
+version-sync = "~0.9"
 
 [package.metadata.docs.rs]
 all-features = true

src/lib.rs

@@ -50,10 +50,10 @@
 //! [w5500-hl]: https://github.com/newAM/w5500-hl-rs
 //! [w5500-regsim]: https://github.com/newAM/w5500-regsim-rs
 //! [Wiznet W5500]: https://www.wiznet.io/product-item/w5500/
-//! [`blocking`]: https://docs.rs/w5500-ll/0.7.0/w5500_ll/blocking/index.html
-//! [`Registers`]: https://docs.rs/w5500-ll/0.7.0/w5500_ll/trait.Registers.html
-//! [`w5500_ll::net`]: https://docs.rs/w5500-ll/0.7.0/w5500_ll/net/index.html
-#![doc(html_root_url = "https://docs.rs/w5500-ll/0.7.0")]
+//! [`blocking`]: https://docs.rs/w5500-ll/0.8.0/w5500_ll/blocking/index.html
+//! [`Registers`]: https://docs.rs/w5500-ll/0.8.0/w5500_ll/trait.Registers.html
+//! [`w5500_ll::net`]: https://docs.rs/w5500-ll/0.8.0/w5500_ll/net/index.html
+#![doc(html_root_url = "https://docs.rs/w5500-ll/0.8.0")]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![forbid(unsafe_code)]
 #![forbid(missing_docs)]

src/specifiers.rs

@@ -559,26 +559,67 @@ pub enum BufferSize {
     KB16 = 16,
 }
 impl From<BufferSize> for u8 {
+    /// Get the register value from a buffer size.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use w5500_ll::BufferSize;
+    ///
+    /// assert_eq!(u8::from(BufferSize::KB0), 0);
+    /// assert_eq!(u8::from(BufferSize::KB1), 1);
+    /// assert_eq!(u8::from(BufferSize::KB2), 2);
+    /// assert_eq!(u8::from(BufferSize::KB4), 4);
+    /// assert_eq!(u8::from(BufferSize::KB8), 8);
+    /// assert_eq!(u8::from(BufferSize::KB16), 16);
+    /// ```
     fn from(val: BufferSize) -> u8 {
         val as u8
     }
 }
+
 impl TryFrom<u8> for BufferSize {
     type Error = u8;
+
+    /// Get the buffer size given the register value.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use core::convert::TryFrom;
+    /// use w5500_ll::BufferSize;
+    ///
+    /// assert_eq!(BufferSize::try_from(0), Ok(BufferSize::KB0));
+    /// assert_eq!(BufferSize::try_from(1), Ok(BufferSize::KB1));
+    /// assert_eq!(BufferSize::try_from(2), Ok(BufferSize::KB2));
+    /// assert_eq!(BufferSize::try_from(4), Ok(BufferSize::KB4));
+    /// assert_eq!(BufferSize::try_from(8), Ok(BufferSize::KB8));
+    /// assert_eq!(BufferSize::try_from(16), Ok(BufferSize::KB16));
+    /// assert_eq!(BufferSize::try_from(17), Err(17));
+    /// ```
     fn try_from(val: u8) -> Result<BufferSize, u8> {
         match val {
             x if x == BufferSize::KB0 as u8 => Ok(BufferSize::KB0),
             x if x == BufferSize::KB1 as u8 => Ok(BufferSize::KB1),
             x if x == BufferSize::KB2 as u8 => Ok(BufferSize::KB2),
-            x if x == BufferSize::KB4 as u8 => Ok(BufferSize::KB0),
-            x if x == BufferSize::KB8 as u8 => Ok(BufferSize::KB0),
-            x if x == BufferSize::KB16 as u8 => Ok(BufferSize::KB0),
+            x if x == BufferSize::KB4 as u8 => Ok(BufferSize::KB4),
+            x if x == BufferSize::KB8 as u8 => Ok(BufferSize::KB8),
+            x if x == BufferSize::KB16 as u8 => Ok(BufferSize::KB16),
             _ => Err(val),
         }
     }
 }
 
 impl Default for BufferSize {
+    /// Default buffer size.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use w5500_ll::BufferSize;
+    ///
+    /// assert_eq!(BufferSize::default(), BufferSize::KB2);
+    /// ```
     fn default() -> Self {
         BufferSize::KB2
     }