add ufmt impl

Author: newAM

.cargo/config.toml

@@ -1,5 +1,5 @@
 [alias]
-test-all = "test --features std,log,embedded-hal,time,chrono,num-rational,w5500-tls"
+test-all = "test --features std,log,embedded-hal,time,chrono,num-rational,w5500-tls,ufmt"
 test-dhcp = "test -p w5500-dhcp --features log,std"
 test-ll = "test -p w5500-ll --features embedded-hal,std"
 test-mqtt = "test -p w5500-mqtt --features log,std,w5500-tls"

ll/Cargo.toml

@@ -14,16 +14,14 @@ homepage = "https://github.com/newAM/w5500-rs"
 [features]
 std = []
 
-[dependencies.embedded-hal]
-version = "0.2.4"
-optional = true
-
-[dependencies.defmt]
-version = "0.3"
-optional = true
+[dependencies]
+embedded-hal = { version = "0.2.4", optional = true }
+defmt = { version = "0.3", optional = true }
+ufmt = { version = "0.1", optional = true }
 
 [dev-dependencies]
 embedded-hal-mock = "0.8"
+ufmt = { version = "0.1", features = ["std"] }
 
 [package.metadata.docs.rs]
 all-features = true

ll/src/net.rs

@@ -272,6 +272,23 @@ impl defmt::Format for Ipv4Addr {
     }
 }
 
+#[cfg(feature = "ufmt")]
+impl ufmt::uDisplay for Ipv4Addr {
+    fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
+    where
+        W: ufmt::uWrite + ?Sized,
+    {
+        ufmt::uwrite!(
+            f,
+            "{}.{}.{}.{}",
+            self.octets[0],
+            self.octets[1],
+            self.octets[2],
+            self.octets[3]
+        )
+    }
+}
+
 #[cfg(feature = "std")]
 impl From<std::net::Ipv4Addr> for Ipv4Addr {
     fn from(ip: std::net::Ipv4Addr) -> Self {
@@ -403,6 +420,27 @@ impl defmt::Format for Eui48Addr {
     }
 }
 
+#[cfg(feature = "ufmt")]
+impl ufmt::uDisplay for Eui48Addr {
+    fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
+    where
+        W: ufmt::uWrite + ?Sized,
+    {
+        // https://github.com/japaric/ufmt/pull/35
+        todo!()
+        // ufmt::uwrite!(
+        //     f,
+        //     "{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}",
+        //     self.octets[0],
+        //     self.octets[1],
+        //     self.octets[2],
+        //     self.octets[3],
+        //     self.octets[4],
+        //     self.octets[5],
+        // )
+    }
+}
+
 impl From<[u8; 6]> for Eui48Addr {
     /// Creates an `Eui48Addr` from a six element byte array.
     ///
@@ -537,6 +575,17 @@ impl defmt::Format for SocketAddrV4 {
     }
 }
 
+
+#[cfg(feature = "ufmt")]
+impl ufmt::uDisplay for SocketAddrV4 {
+    fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
+    where
+        W: ufmt::uWrite + ?Sized,
+    {
+        ufmt::uwrite!(f, "{}:{}", self.ip(), self.port())
+    }
+}
+
 #[cfg(feature = "std")]
 impl From<std::net::SocketAddrV4> for SocketAddrV4 {
     fn from(addr: std::net::SocketAddrV4) -> Self {

ll/src/specifiers.rs

@@ -7,6 +7,7 @@
 /// [`sn_sr`]: crate::Registers::sn_sr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum SocketStatus {
     /// Socket closed, this is the reset state of all sockets.
@@ -185,6 +186,7 @@ impl Default for SocketStatus {
 /// [`sn_sr`]: crate::Registers::sn_sr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum SocketCommand {
     /// The command register clears to this state once a command has been
@@ -361,6 +363,7 @@ impl TryFrom<u8> for SocketCommand {
 /// [`sn_mr`]: crate::Registers::sn_mr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum Protocol {
     /// Closed.
@@ -428,6 +431,7 @@ impl TryFrom<u8> for Protocol {
 /// [`phycfgr`]: crate::Registers::phycfgr
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum OperationMode {
     /// 10BT half-duplex. Auto-negotiation disabled.
@@ -510,6 +514,7 @@ impl Default for OperationMode {
 /// [`phycfgr`]: crate::Registers::phycfgr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum LinkStatus {
     /// PHY link down.
@@ -545,6 +550,7 @@ impl Default for LinkStatus {
 /// [`phycfgr`]: crate::Registers::phycfgr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum SpeedStatus {
     /// 10 Mbps.
@@ -580,6 +586,7 @@ impl Default for SpeedStatus {
 /// [`phycfgr`]: crate::Registers::phycfgr
 #[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 pub enum DuplexStatus {
     /// Half duplex
@@ -616,6 +623,7 @@ impl Default for DuplexStatus {
 /// [`Registers::set_sn_rxbuf_size`]: crate::Registers::set_sn_rxbuf_size
 #[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Hash, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 #[repr(u8)]
 #[allow(clippy::upper_case_acronyms)]
 pub enum BufferSize {

ll/src/spi.rs

@@ -4,6 +4,7 @@
 #[repr(u8)]
 #[derive(PartialEq, Eq, Copy, Clone, Debug, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
 pub enum AccessMode {
     /// Read access.
     Read = 0,

ll/tests/net_format.rs

@@ -1,19 +1,49 @@
 use w5500_ll::net::{Eui48Addr, Ipv4Addr, SocketAddrV4};
 
+const MAC_FMT_CASES: &[(Eui48Addr, &str)] = &[
+    (
+        Eui48Addr::new(0x01, 0x23, 0x45, 0x67, 0x89, 0xAB),
+        "01:23:45:67:89:AB",
+    ),
+    (Eui48Addr::UNSPECIFIED, "00:00:00:00:00:00"),
+];
+
 #[test]
 fn mac_format() {
-    assert_eq!(
-        format!("{}", Eui48Addr::new(0x01, 0x23, 0x45, 0x67, 0x89, 0xAB)),
-        "01:23:45:67:89:AB"
-    );
-    assert_eq!(format!("{}", Eui48Addr::UNSPECIFIED), "00:00:00:00:00:00")
+    for (mac, expected) in MAC_FMT_CASES {
+        assert_eq!(format!("{mac}"), *expected);
+    }
+}
+
+#[test]
+fn mac_uformat() {
+    for (mac, expected) in MAC_FMT_CASES {
+        let mut s = String::new();
+        ufmt::uwrite!(s, "{}", mac).unwrap();
+        assert_eq!(s, *expected);
+    }
 }
 
+const IPV4_FMT_CASES: &[(Ipv4Addr, &str)] = &[
+    (Ipv4Addr::new(1, 2, 3, 4), "1.2.3.4"),
+    (Ipv4Addr::BROADCAST, "255.255.255.255"),
+    (Ipv4Addr::UNSPECIFIED, "0.0.0.0"),
+];
+
 #[test]
 fn ipv4_format() {
-    assert_eq!(format!("{}", Ipv4Addr::new(1, 2, 3, 4)), "1.2.3.4");
-    assert_eq!(format!("{}", Ipv4Addr::BROADCAST), "255.255.255.255");
-    assert_eq!(format!("{}", Ipv4Addr::UNSPECIFIED), "0.0.0.0")
+    for (ip, expected) in IPV4_FMT_CASES {
+        assert_eq!(format!("{ip}"), *expected);
+    }
+}
+
+#[test]
+fn ipv4_uformat() {
+    for (ip, expected) in IPV4_FMT_CASES {
+        let mut s = String::new();
+        ufmt::uwrite!(s, "{}", ip).unwrap();
+        assert_eq!(s, *expected);
+    }
 }
 
 #[test]