Option to only select a subset of the embassy-net/smoltcp features (#71)

ivmarkov · web-flow · commit 0ef522d6c850 · 2025-05-29T13:06:06.000+03:00
* Option to only select a subset of the embassy-net/smoltcp features

* Update to embassy-net 0.7

* Raise the embedded-sync version

* Suppress uninlined format args warn

* Fix CI

* Update changelog

* Update crate versions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -35,11 +35,11 @@ jobs:
       - name: Build | Fmt Check
         run: cargo fmt -- --check
       - name: Build | Clippy
-        run: cargo clippy --features std,embedded-svc,edge-nal-embassy --examples --no-deps -- -Dwarnings
+        run: cargo clippy --features std,embedded-svc,edge-nal-embassy/all --examples --no-deps -- -Dwarnings
       - name: Build | Clippy - defmt
-        run: cargo clippy --features std,embedded-svc,edge-nal-embassy,defmt --no-deps -- -Dwarnings
+        run: cargo clippy --features std,embedded-svc,edge-nal-embassy/all,defmt --no-deps -- -Dwarnings
       - name: Build | Clippy - log
-        run: cargo clippy --features std,embedded-svc,edge-nal-embassy,log --examples --no-deps -- -Dwarnings
+        run: cargo clippy --features std,embedded-svc,edge-nal-embassy/all,log --examples --no-deps -- -Dwarnings
       - name: Build | Default
         run: cargo build --features log
       - name: Build | Non-default
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-net"
-version = "0.10.1"
+version = "0.11.0"
 authors = ["Ivan Markov <ivan.markov@gmail.com>"]
 edition = "2021"
 categories = ["embedded", "hardware-support", "network-programming", "asynchronous"]
@@ -15,7 +15,7 @@ rust-version = "1.83"
 default = ["io"]
 async-io-mini = ["std", "edge-nal-std/async-io-mini"]
 std = ["io", "edge-captive/std", "edge-dhcp/std", "edge-http/std", "edge-mdns/std", "edge-raw/std", "edge-mqtt", "edge-ws/std", "edge-nal-std"]
-embassy = ["io", "edge-nal-embassy"]
+embassy = ["io", "edge-nal-embassy/all"]
 io = ["edge-captive/io", "edge-dhcp/io", "edge-http/io", "edge-mdns/io", "edge-raw/io", "edge-ws/io", "edge-nal"]
 log = ["edge-captive/log", "edge-dhcp/log", "edge-http/log", "edge-mdns/log", "edge-raw/log", "edge-ws/log", "edge-nal-embassy?/log"]
 defmt = ["edge-captive/defmt", "edge-dhcp/defmt", "edge-http/defmt", "edge-mdns/defmt", "edge-raw/defmt", "edge-ws/defmt", "edge-nal-embassy?/defmt"]
@@ -40,7 +40,7 @@ anyhow = "1"
 env_logger = "0.10"
 embedded-io-async = "0.6"
 embassy-time = { version = "0.4", features = ["std", "generic-queue-64"] }
-embassy-sync = "0.6"
+embassy-sync = "0.7"
 embassy-futures = "0.1"
 embedded-svc = { version = "0.28", features = ["std"] }
 futures-lite = "2"
@@ -109,20 +109,20 @@ members = [
 
 [workspace.dependencies]
 embassy-futures = { version = "0.1", default-features = false }
-embassy-sync = { version = "0.6", default-features = false }
+embassy-sync = { version = "0.7", default-features = false }
 embassy-time = { version = "0.4", default-features = false }
 embedded-io-async = { version = "0.6", default-features = false }
 embedded-svc = { version = "0.28", default-features = false }
 heapless = { version = "0.8", default-features = false }
 domain = { version = "0.10", default-features = false, features = ["heapless"] }
 
-edge-captive = { version = "0.5.0", path = "edge-captive", default-features = false }
-edge-dhcp = { version = "0.5.0", path = "edge-dhcp", default-features = false }
-edge-http = { version = "0.5.1", path = "edge-http", default-features = false }
-edge-mdns = { version = "0.5.0", path = "edge-mdns", default-features = false }
+edge-captive = { version = "0.6.0", path = "edge-captive", default-features = false }
+edge-dhcp = { version = "0.6.0", path = "edge-dhcp", default-features = false }
+edge-http = { version = "0.6.0", path = "edge-http", default-features = false }
+edge-mdns = { version = "0.6.0", path = "edge-mdns", default-features = false }
 edge-mqtt = { version = "0.4.0", path = "edge-mqtt", default-features = false }
 edge-nal = { version = "0.5.0", path = "edge-nal", default-features = false }
-edge-raw = { version = "0.5.0", path = "edge-raw", default-features = false }
-edge-ws = { version = "0.4.0", path = "edge-ws", default-features = false }
+edge-raw = { version = "0.6.0", path = "edge-raw", default-features = false }
+edge-ws = { version = "0.5.0", path = "edge-ws", default-features = false }
 edge-nal-std = { version = "0.5.0", path = "edge-nal-std", default-features = false }
-edge-nal-embassy = { version = "0.5.0", path = "edge-nal-embassy", default-features = false }
+edge-nal-embassy = { version = "0.6.0", path = "edge-nal-embassy", default-features = false }
diff --git a/edge-captive/CHANGELOG.md b/edge-captive/CHANGELOG.md
@@ -5,7 +5,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.6.0] - 2025-05-29
 * Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
   * `log` - uses the `log` crate for all logging
   * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
diff --git a/edge-captive/Cargo.toml b/edge-captive/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-captive"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 rust-version = "1.83"
 description = "Async + `no_std` + no-alloc implementation of a Captive Portal DNS"
diff --git a/edge-captive/src/lib.rs b/edge-captive/src/lib.rs
@@ -1,5 +1,7 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![warn(clippy::large_futures)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 use core::fmt::Display;
 use core::time::Duration;
diff --git a/edge-dhcp/CHANGELOG.md b/edge-dhcp/CHANGELOG.md
@@ -5,7 +5,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.6.0] - 2025-05-29
 * Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
   * `log` - uses the `log` crate for all logging
   * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
diff --git a/edge-dhcp/Cargo.toml b/edge-dhcp/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-dhcp"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 rust-version = "1.83"
 description = "Async + `no_std` + no-alloc implementation of the DHCP protocol"
diff --git a/edge-dhcp/src/lib.rs b/edge-dhcp/src/lib.rs
@@ -1,5 +1,7 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![warn(clippy::large_futures)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 /// This code is a `no_std` and no-alloc modification of https://github.com/krolaw/dhcp4r
 use core::str::Utf8Error;
diff --git a/edge-http/CHANGELOG.md b/edge-http/CHANGELOG.md
@@ -5,7 +5,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.6.0] - 2025-05-29
 * Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
   * `log` - uses the `log` crate for all logging
   * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
diff --git a/edge-http/Cargo.toml b/edge-http/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-http"
-version = "0.5.1"
+version = "0.6.0"
 edition = "2021"
 rust-version = "1.83"
 description = "Async + `no_std` + no-alloc implementation of the HTTP protocol"
diff --git a/edge-http/src/lib.rs b/edge-http/src/lib.rs
@@ -1,6 +1,8 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![allow(async_fn_in_trait)]
 #![warn(clippy::large_futures)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 use core::fmt::Display;
 use core::str;
diff --git a/edge-mdns/CHANGELOG.md b/edge-mdns/CHANGELOG.md
@@ -5,7 +5,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.6.0] - 2025-05-29
 * Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
   * `log` - uses the `log` crate for all logging
   * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
diff --git a/edge-mdns/Cargo.toml b/edge-mdns/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-mdns"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 description = "Async + `no_std` + no-alloc implementation of an mDNS responder"
 repository = "https://github.com/ivmarkov/edge-net"
diff --git a/edge-mdns/src/lib.rs b/edge-mdns/src/lib.rs
@@ -1,6 +1,8 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![warn(clippy::large_futures)]
 #![allow(async_fn_in_trait)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 use core::cmp::Ordering;
 use core::fmt::Display;
diff --git a/edge-mqtt/src/lib.rs b/edge-mqtt/src/lib.rs
@@ -1,3 +1,5 @@
 #![warn(clippy::large_futures)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 pub mod io;
diff --git a/edge-nal-embassy/CHANGELOG.md b/edge-nal-embassy/CHANGELOG.md
@@ -5,10 +5,12 @@ 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.6.0] - 2025-05-29
 * Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
   * `log` - uses the `log` crate for all logging
   * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
+* Updated to `embassy-net` 0.7
+* Re-export all `embassy-net` features as `edge-nal-embassy` features; `all` feature that enables all features of `embassy-net`
 
 ## [0.5.0] - 2025-01-15
 * Updated dependencies for compatibility with `embassy-time-driver` v0.2
diff --git a/edge-nal-embassy/Cargo.toml b/edge-nal-embassy/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-nal-embassy"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 rust-version = "1.83"
 description = "An implementation of edge-nal based on `embassy-net`"
@@ -15,22 +15,26 @@ categories = [
 ]
 
 [features]
+default = ["all"]
+all = ["proto-ipv4", "proto-ipv6", "medium-ethernet", "medium-ip", "dns", "udp", "tcp", "multicast", "icmp", "dhcpv4", "dhcpv4-hostname"]
 defmt = ["dep:defmt", "heapless/defmt-03", "embassy-net/defmt"]
+proto-ipv4 = ["embassy-net/proto-ipv4"]
+proto-ipv6 = ["embassy-net/proto-ipv6"]
+medium-ethernet = ["embassy-net/medium-ethernet"]
+medium-ip = ["embassy-net/medium-ip"]
+dns = ["embassy-net/dns"]
+udp = ["embassy-net/udp"]
+tcp = ["embassy-net/tcp"]
+icmp = ["embassy-net/icmp"]
+multicast = ["embassy-net/multicast"]
+dhcpv4 = ["embassy-net/dhcpv4"]
+dhcpv4-hostname = ["embassy-net/dhcpv4-hostname"]
 
 [dependencies]
 log = { version = "0.4", default-features = false, optional = true }
 defmt = { version = "0.3", optional = true }
 embedded-io-async = { workspace = true }
 edge-nal = { workspace = true }
 heapless = { workspace = true }
-# Do not require these features and conditionalize the code instead
-embassy-net = { version = "0.6", features = [
-    "tcp",
-    "udp",
-    "dns",
-    "proto-ipv6",
-    "medium-ethernet",
-    "proto-ipv4",
-    "multicast",
-] }
+embassy-net = "0.7"
 embassy-futures = { workspace = true }
diff --git a/edge-nal-embassy/src/lib.rs b/edge-nal-embassy/src/lib.rs
@@ -1,23 +1,31 @@
 #![no_std]
 #![allow(async_fn_in_trait)]
 #![warn(clippy::large_futures)]
+#![allow(clippy::uninlined_format_args)]
+#![allow(unknown_lints)]
 
 use core::cell::{Cell, UnsafeCell};
 use core::mem::MaybeUninit;
-use core::net::SocketAddr;
+use core::net::{IpAddr, SocketAddr};
 use core::ptr::NonNull;
 
-use embassy_net::{IpEndpoint, IpListenEndpoint};
+use embassy_net::{IpAddress, IpEndpoint, IpListenEndpoint};
 
+#[cfg(feature = "dns")]
 pub use dns::*;
+#[cfg(feature = "tcp")]
 pub use tcp::*;
+#[cfg(feature = "udp")]
 pub use udp::*;
 
 // This mod MUST go first, so that the others see its macros.
 pub(crate) mod fmt;
 
+#[cfg(feature = "dns")]
 mod dns;
+#[cfg(feature = "tcp")]
 mod tcp;
+#[cfg(feature = "udp")]
 mod udp;
 
 pub(crate) struct Pool<T, const N: usize> {
@@ -66,26 +74,33 @@ pub(crate) fn to_net_socket(socket: IpEndpoint) -> SocketAddr {
     SocketAddr::new(socket.addr.into(), socket.port)
 }
 
-// pub(crate) fn to_net_socket2(socket: IpListenEndpoint) -> SocketAddr {
-//     SocketAddr::new(
-//         socket
-//             .addr
-//             .map(to_net_addr)
-//             .unwrap_or(IpAddr::V6(Ipv6Addr::UNSPECIFIED)),
-//         socket.port,
-//     )
-// }
-
-pub(crate) fn to_emb_socket(socket: SocketAddr) -> IpEndpoint {
-    IpEndpoint {
-        addr: socket.ip().into(),
+pub(crate) fn to_emb_socket(socket: SocketAddr) -> Option<IpEndpoint> {
+    Some(IpEndpoint {
+        addr: to_emb_addr(socket.ip())?,
         port: socket.port(),
-    }
+    })
 }
 
-pub(crate) fn to_emb_bind_socket(socket: SocketAddr) -> IpListenEndpoint {
-    IpListenEndpoint {
-        addr: (!socket.ip().is_unspecified()).then(|| socket.ip().into()),
+pub(crate) fn to_emb_bind_socket(socket: SocketAddr) -> Option<IpListenEndpoint> {
+    let addr = if socket.ip().is_unspecified() {
+        None
+    } else {
+        Some(to_emb_addr(socket.ip())?)
+    };
+
+    Some(IpListenEndpoint {
+        addr,
         port: socket.port(),
+    })
+}
+
+pub(crate) fn to_emb_addr(addr: IpAddr) -> Option<IpAddress> {
+    match addr {
+        #[cfg(feature = "proto-ipv4")]
+        IpAddr::V4(addr) => Some(addr.into()),
+        #[cfg(feature = "proto-ipv6")]
+        IpAddr::V6(addr) => Some(addr.into()),
+        #[allow(unreachable_patterns)]
+        _ => None,
     }
 }
diff --git a/edge-nal-embassy/src/tcp.rs b/edge-nal-embassy/src/tcp.rs
@@ -44,7 +44,10 @@ impl<const N: usize, const TX_SZ: usize, const RX_SZ: usize> TcpConnect
     async fn connect(&self, remote: SocketAddr) -> Result<Self::Socket<'_>, Self::Error> {
         let mut socket = TcpSocket::new(self.stack, self.buffers)?;
 
-        socket.socket.connect(to_emb_socket(remote)).await?;
+        socket
+            .socket
+            .connect(to_emb_socket(remote).ok_or(TcpError::UnsupportedProto)?)
+            .await?;
 
         Ok(socket)
     }
@@ -82,7 +85,10 @@ impl<const N: usize, const TX_SZ: usize, const RX_SZ: usize> edge_nal::TcpAccept
     async fn accept(&self) -> Result<(SocketAddr, Self::Socket<'_>), Self::Error> {
         let mut socket = TcpSocket::new(self.stack.stack, self.stack.buffers)?;
 
-        socket.socket.accept(to_emb_bind_socket(self.local)).await?;
+        socket
+            .socket
+            .accept(to_emb_bind_socket(self.local).ok_or(TcpError::UnsupportedProto)?)
+            .await?;
 
         let local_endpoint = unwrap!(socket.socket.local_endpoint());
 
@@ -286,6 +292,7 @@ pub enum TcpError {
     Connect(ConnectError),
     Accept(AcceptError),
     NoBuffers,
+    UnsupportedProto,
 }
 
 impl From<Error> for TcpError {
@@ -314,6 +321,7 @@ impl embedded_io_async::Error for TcpError {
             TcpError::Connect(_) => ErrorKind::Other,
             TcpError::Accept(_) => ErrorKind::Other,
             TcpError::NoBuffers => ErrorKind::OutOfMemory,
+            TcpError::UnsupportedProto => ErrorKind::InvalidInput,
         }
     }
 }
diff --git a/edge-nal-embassy/src/udp.rs b/edge-nal-embassy/src/udp.rs
diff --git a/edge-nal-std/src/lib.rs b/edge-nal-std/src/lib.rs
diff --git a/edge-nal/src/lib.rs b/edge-nal/src/lib.rs
diff --git a/edge-raw/CHANGELOG.md b/edge-raw/CHANGELOG.md
diff --git a/edge-raw/Cargo.toml b/edge-raw/Cargo.toml
diff --git a/edge-raw/src/lib.rs b/edge-raw/src/lib.rs
diff --git a/edge-ws/CHANGELOG.md b/edge-ws/CHANGELOG.md
diff --git a/edge-ws/Cargo.toml b/edge-ws/Cargo.toml
diff --git a/edge-ws/src/lib.rs b/edge-ws/src/lib.rs
