Skip to content

Commit b0adea4

Browse files
newAMnewAM
committed
add ufmt impl
1 parent 152d442 commit b0adea4

File tree

6 files changed

+120
-24
lines changed

6 files changed

+120
-24
lines changed

‎.cargo/config.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[alias]
2-
test-all = "test --features std,log,eh0,eh1,time,chrono,num-rational,w5500-tls"
2+
test-all = "test --features std,log,eh0,eh1,time,chrono,num-rational,w5500-tls,ufmt"
33
test-dhcp = "test -p w5500-dhcp --features log,std"
44
test-ll = "test -p w5500-ll --features eh0,eh1,std"
55
test-hl = "test -p w5500-hl --features eh0,eh1,std"

‎ll/Cargo.toml

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
[package]
23
name = "w5500-ll"
34
version = "0.10.4"
@@ -12,17 +13,18 @@ categories = ["embedded", "hardware-support", "no-std"]
1213
homepage = "https://github.com/newAM/w5500-rs"
1314

1415
[features]
15-
std = []
16+
std = [ "ufmt?/std" ]
1617

1718
[dependencies]
19+
defmt = { version = "0.3", optional = true }
1820
eh0 = { package = "embedded-hal", version = "0.2.7", optional = true }
1921
eh1 = { package = "embedded-hal", version = "1.0.0-alpha.8", optional = true }
20-
defmt = { version = "0.3", optional = true }
22+
ufmt = { version = "0.2", optional = true }
2123

2224
[dev-dependencies]
2325
ehm0 = { package = "embedded-hal-mock", version = "0.8" }
2426
ehm1 = { package = "embedded-hal-mock", git = "https://github.com/dbrgn/embedded-hal-mock", branch = "1-alpha" }
2527

2628
[package.metadata.docs.rs]
2729
all-features = true
28-
rustdoc-args = ["--cfg", "docsrs"]
30+
rustdoc-args = ["--cfg", "docsrs"]

‎ll/src/net.rs

+48
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,23 @@ impl defmt::Format for Ipv4Addr {
272272
}
273273
}
274274

275+
#[cfg(feature = "ufmt")]
276+
impl ufmt::uDisplay for Ipv4Addr {
277+
fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
278+
where
279+
W: ufmt::uWrite + ?Sized,
280+
{
281+
ufmt::uwrite!(
282+
f,
283+
"{}.{}.{}.{}",
284+
self.octets[0],
285+
self.octets[1],
286+
self.octets[2],
287+
self.octets[3]
288+
)
289+
}
290+
}
291+
275292
#[cfg(feature = "std")]
276293
impl From<std::net::Ipv4Addr> for Ipv4Addr {
277294
fn from(ip: std::net::Ipv4Addr) -> Self {
@@ -403,6 +420,26 @@ impl defmt::Format for Eui48Addr {
403420
}
404421
}
405422

423+
#[cfg(feature = "ufmt")]
424+
impl ufmt::uDisplay for Eui48Addr {
425+
fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
426+
where
427+
W: ufmt::uWrite + ?Sized,
428+
{
429+
// https://github.com/japaric/ufmt/pull/35
430+
ufmt::uwrite!(
431+
f,
432+
"{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}",
433+
self.octets[0],
434+
self.octets[1],
435+
self.octets[2],
436+
self.octets[3],
437+
self.octets[4],
438+
self.octets[5],
439+
)
440+
}
441+
}
442+
406443
impl From<[u8; 6]> for Eui48Addr {
407444
/// Creates an `Eui48Addr` from a six element byte array.
408445
///
@@ -537,6 +574,17 @@ impl defmt::Format for SocketAddrV4 {
537574
}
538575
}
539576

577+
578+
#[cfg(feature = "ufmt")]
579+
impl ufmt::uDisplay for SocketAddrV4 {
580+
fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
581+
where
582+
W: ufmt::uWrite + ?Sized,
583+
{
584+
ufmt::uwrite!(f, "{}:{}", self.ip(), self.port())
585+
}
586+
}
587+
540588
#[cfg(feature = "std")]
541589
impl From<std::net::SocketAddrV4> for SocketAddrV4 {
542590
fn from(addr: std::net::SocketAddrV4) -> Self {

‎ll/src/specifiers.rs

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
/// [`sn_sr`]: crate::Registers::sn_sr
88
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
99
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
10+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
1011
#[repr(u8)]
1112
pub enum SocketStatus {
1213
/// Socket closed, this is the reset state of all sockets.
@@ -185,6 +186,7 @@ impl Default for SocketStatus {
185186
/// [`sn_sr`]: crate::Registers::sn_sr
186187
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
187188
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
189+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
188190
#[repr(u8)]
189191
pub enum SocketCommand {
190192
/// The command register clears to this state once a command has been
@@ -361,6 +363,7 @@ impl TryFrom<u8> for SocketCommand {
361363
/// [`sn_mr`]: crate::Registers::sn_mr
362364
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
363365
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
366+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
364367
#[repr(u8)]
365368
pub enum Protocol {
366369
/// Closed.
@@ -428,6 +431,7 @@ impl TryFrom<u8> for Protocol {
428431
/// [`phycfgr`]: crate::Registers::phycfgr
429432
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
430433
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
434+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
431435
#[repr(u8)]
432436
pub enum OperationMode {
433437
/// 10BT half-duplex. Auto-negotiation disabled.
@@ -510,6 +514,7 @@ impl Default for OperationMode {
510514
/// [`phycfgr`]: crate::Registers::phycfgr
511515
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
512516
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
517+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
513518
#[repr(u8)]
514519
pub enum LinkStatus {
515520
/// PHY link down.
@@ -545,6 +550,7 @@ impl Default for LinkStatus {
545550
/// [`phycfgr`]: crate::Registers::phycfgr
546551
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
547552
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
553+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
548554
#[repr(u8)]
549555
pub enum SpeedStatus {
550556
/// 10 Mbps.
@@ -580,6 +586,7 @@ impl Default for SpeedStatus {
580586
/// [`phycfgr`]: crate::Registers::phycfgr
581587
#[derive(Copy, Clone, Eq, PartialEq, Debug, PartialOrd, Ord, Hash)]
582588
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
589+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
583590
#[repr(u8)]
584591
pub enum DuplexStatus {
585592
/// Half duplex
@@ -616,6 +623,7 @@ impl Default for DuplexStatus {
616623
/// [`Registers::set_sn_rxbuf_size`]: crate::Registers::set_sn_rxbuf_size
617624
#[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Hash, Debug)]
618625
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
626+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
619627
#[repr(u8)]
620628
#[allow(clippy::upper_case_acronyms)]
621629
pub enum BufferSize {

‎ll/src/spi.rs

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#[repr(u8)]
55
#[derive(PartialEq, Eq, Copy, Clone, Debug, Hash)]
66
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
7+
#[cfg_attr(feature = "ufmt", derive(ufmt::derive::uDebug))]
78
pub enum AccessMode {
89
/// Read access.
910
Read = 0,

‎ll/tests/net_format.rs

+57-20
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,70 @@
11
use w5500_ll::net::{Eui48Addr, Ipv4Addr, SocketAddrV4};
22

3+
const MAC_FMT_CASES: &[(Eui48Addr, &str)] = &[
4+
(
5+
Eui48Addr::new(0x01, 0x23, 0x45, 0x67, 0x89, 0xAB),
6+
"01:23:45:67:89:AB",
7+
),
8+
(Eui48Addr::UNSPECIFIED, "00:00:00:00:00:00"),
9+
];
10+
311
#[test]
412
fn mac_format() {
5-
assert_eq!(
6-
format!("{}", Eui48Addr::new(0x01, 0x23, 0x45, 0x67, 0x89, 0xAB)),
7-
"01:23:45:67:89:AB"
8-
);
9-
assert_eq!(format!("{}", Eui48Addr::UNSPECIFIED), "00:00:00:00:00:00")
13+
for (mac, expected) in MAC_FMT_CASES {
14+
assert_eq!(format!("{mac}"), *expected);
15+
}
1016
}
1117

18+
#[test]
19+
fn mac_uformat() {
20+
for (mac, expected) in MAC_FMT_CASES {
21+
let mut s = String::new();
22+
ufmt::uwrite!(s, "{}", mac).unwrap();
23+
assert_eq!(s, *expected);
24+
}
25+
}
26+
27+
const IPV4_FMT_CASES: &[(Ipv4Addr, &str)] = &[
28+
(Ipv4Addr::new(1, 2, 3, 4), "1.2.3.4"),
29+
(Ipv4Addr::BROADCAST, "255.255.255.255"),
30+
(Ipv4Addr::UNSPECIFIED, "0.0.0.0"),
31+
];
32+
1233
#[test]
1334
fn ipv4_format() {
14-
assert_eq!(format!("{}", Ipv4Addr::new(1, 2, 3, 4)), "1.2.3.4");
15-
assert_eq!(format!("{}", Ipv4Addr::BROADCAST), "255.255.255.255");
16-
assert_eq!(format!("{}", Ipv4Addr::UNSPECIFIED), "0.0.0.0")
35+
for (ip, expected) in IPV4_FMT_CASES {
36+
assert_eq!(format!("{ip}"), *expected);
37+
}
1738
}
1839

40+
#[test]
41+
fn ipv4_uformat() {
42+
for (ip, expected) in IPV4_FMT_CASES {
43+
let mut s = String::new();
44+
ufmt::uwrite!(s, "{}", ip).unwrap();
45+
assert_eq!(s, *expected);
46+
}
47+
}
48+
49+
const SOCKET_ADDR_FMT_CASES: &[(SocketAddrV4, &str)] = &[
50+
(SocketAddrV4::new(Ipv4Addr::new(1, 2, 3, 4), 60), "1.2.3.4:60"),
51+
(SocketAddrV4::new(Ipv4Addr::BROADCAST, u16::MAX), "255.255.255.255:65535"),
52+
(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0), "0.0.0.0:0"),
53+
];
54+
1955
#[test]
2056
fn socket_addr_format() {
21-
assert_eq!(
22-
format!("{}", SocketAddrV4::new(Ipv4Addr::new(1, 2, 3, 4), 60)),
23-
"1.2.3.4:60"
24-
);
25-
assert_eq!(
26-
format!("{}", SocketAddrV4::new(Ipv4Addr::BROADCAST, u16::MAX)),
27-
"255.255.255.255:65535"
28-
);
29-
assert_eq!(
30-
format!("{}", SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0)),
31-
"0.0.0.0:0"
32-
)
57+
for (addr, expected) in SOCKET_ADDR_FMT_CASES {
58+
assert_eq!(format!("{addr}"), *expected);
59+
}
60+
}
61+
62+
63+
#[test]
64+
fn socket_addr_uformat() {
65+
for (addr, expected) in SOCKET_ADDR_FMT_CASES {
66+
let mut s = String::new();
67+
ufmt::uwrite!(s, "{}", addr).unwrap();
68+
assert_eq!(s, *expected);
69+
}
3370
}

0 commit comments

Comments
 (0)