Prep for a new release

ivmarkov · ivmarkov · commit 6fc1c5d3d930 · 2024-09-10T18:46:45.000Z
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-net"
-version = "0.7.1"
+version = "0.8.0"
 authors = ["Ivan Markov <ivan.markov@gmail.com>"]
 edition = "2021"
 categories = ["embedded", "hardware-support"]
diff --git a/edge-captive/CHANGELOG.md b/edge-captive/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+* Migrated to the `edge-nal` traits
+* Updated `domain` to 0.10
+* Raised MSRV to 1.77
diff --git a/edge-captive/Cargo.toml b/edge-captive/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-captive"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Async + `no_std` + no-alloc implementation of a Captive Portal DNS"
diff --git a/edge-dhcp/CHANGELOG.md b/edge-dhcp/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+* Migrated the client and the server to the `edge-nal` traits
+* Migrated the server to only require `UdpSend` and `UdpReceive`, without the need to manipulate raw IP payloads anymore
+* Raised MSRV to 1.77
+
diff --git a/edge-dhcp/Cargo.toml b/edge-dhcp/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-dhcp"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Async + `no_std` + no-alloc implementation of the DHCP protocol"
diff --git a/edge-http/CHANGELOG.md b/edge-http/CHANGELOG.md
@@ -5,6 +5,11 @@ 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).
 
+## [0.3.0] - 2024-09-10
+* Migrated the client and the server to the `edge-nal` traits
+* Fixed a nasty bug where when multiple HTTP requests were carried over a single TCP connection, in certain cases the server was "eating" into the data of the next HTTP request
+* #20 - Removed a misleading warning log "Connection(IncompleteHeaders)"
+
 ## [0.2.1] - 2024-02-01
 * Fixed a wrong header name which caused WS client socket upgrade to fail
 
diff --git a/edge-http/Cargo.toml b/edge-http/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-http"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Async + `no_std` + no-alloc implementation of the HTTP protocol"
diff --git a/edge-mdns/CHANGELOG.md b/edge-mdns/CHANGELOG.md
@@ -0,0 +1,21 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+Almost a complete rewrite:
+* New query API (`Mdns::query`) complementing the responder / query answers' processing one (`Mdns::run`)
+* `domain` API is now also a public API of `edge-mdns`, re-exported as `edge_mdns::domain`
+* IO layer now uses the UDP traits from `edge-net`
+* Traits:
+  * `MdnsHandler` - abstracts the overall processing of an incoming mDNS message
+  * `HostAnswers` - abstracts the generation of answers to peer queries (implemented by the pre-existing `Host` and `Service` struct types)
+  * `HostQuestions` - , `PeerAnswers`
+Smaller items:
+* Raised the `domain` dependency to 0.10
+* Optimized memory usage by avoiding on-stack allocation of large `heapless::String`s
+* IO layer of `edge-mdns` can now share its buffers with other code (see the `BufferAccess` trait)
+* Raised MSRV to 1.77
diff --git a/edge-mdns/Cargo.toml b/edge-mdns/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-mdns"
-version = "0.2.0"
+version = "0.3.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-mqtt/CHANGELOG.md b/edge-mqtt/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+* Raised MSRV to 1.77
+* Support for `embedded-svc` 0.28
diff --git a/edge-mqtt/Cargo.toml b/edge-mqtt/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-mqtt"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Implements the embedded-svc MQTT traits on top of the rumqttc crate"
diff --git a/edge-nal-embassy/CHANGELOG.md b/edge-nal-embassy/CHANGELOG.md
@@ -4,3 +4,6 @@ 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).
+
+## [0.3.0] - 2024-09-10
+* First release (with version 0.3.0 to align with the other `edge-net` crates)
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.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Am implementation of edge-nal based on `embassy-net`"
diff --git a/edge-nal-std/CHANGELOG.md b/edge-nal-std/CHANGELOG.md
@@ -5,6 +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).
 
+## [0.3.0] - 2024-09-10
+* Crate name changed from `edge-std-nal-async` to just `edge-nal-std`
+* Support for `embedded-nal-async` removed as the traits in that crate are too limited
+* STD support is now targetting the traits of our own "nal" crate - `edge-nal`
+* STD support can optionally use the `async-io-mini` crate instead of the default `async-io`
+
 ## [0.2.0] - 2024-02-01
 * Do not compile the `RawSocket` implementation for the ESP IDF, as it is missing the `sockaddr_ll` structure in `libc`
 * Retire `StdTcpSocketRef` in favor of simply using `&StdTcpSocket`
diff --git a/edge-nal-std/Cargo.toml b/edge-nal-std/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-nal-std"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "A STD implementation of edge-nal based on `async-io`"
diff --git a/edge-nal/CHANGELOG.md b/edge-nal/CHANGELOG.md
@@ -5,3 +5,5 @@ 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).
 
+## [0.3.0] - 2024-09-10
+* First release (with version 0.3.0 to align with the other `edge-net` crates)
diff --git a/edge-nal/Cargo.toml b/edge-nal/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-nal"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Hosts a bunch of traits which are not yet available in the embedded-nal-async crate"
diff --git a/edge-nal/README.md b/edge-nal/README.md
@@ -4,7 +4,7 @@
 ![crates.io](https://img.shields.io/crates/v/edge-net.svg)
 [![Documentation](https://docs.rs/edge-net/badge.svg)](https://docs.rs/edge-net)
 
-Hosts a bunch of traits which hopefully will be upstreamed into [embedded-nal-async](https://github.com/rust-embedded-community/embedded-nal/tree/master/embedded-nal-async) at some point in time - in one shape or another.
+Hosts a bunch of networking (UDP, TCP and raw ethernet) traits.
 
 ## Differences with [embedded-nal-async](https://github.com/rust-embedded-community/embedded-nal/tree/master/embedded-nal-async)
 
@@ -19,8 +19,9 @@ Hosts a bunch of traits which hopefully will be upstreamed into [embedded-nal-as
 * Binding to a UDP socket and connecting to a UDP socket modeled with separate traits - `UdpBind` and `UdpConnect`, as not all platforms currently have capabilities to connect to a UDP socket (i.e. the networking stack of Embassy)
 * Returning the local address of a UDP socket bind / connect operation is not supported, as not all platforms currently have this capability (i.e. the networking stack of Embassy)
 * "Unbound" UDP sockets are currently not supported, as not all platforms have these capabilities (i.e. the networking stack of Embassy). Also, I've yet to find a good use case for these.
-* Splittable sockets with `UdpSplit` (can be optionally implemented by `UdpConnect` and `UdpBind`)
+* Splittable sockets with `UdpSplit`
 * `Multicast` trait for joining / leaving IPv4 and IPv6 multicast groups (can be optionally implemented by `UdpConnect` and `UdpBind`)
+* `Readable` trait for waiting until a socket becomes readable
 
 ## Justification
 
@@ -59,6 +60,8 @@ Namely:
   * Udp socket factory similar in spirit to STD's `std::net::UdpSocket::connect` method
 * [Multicast](src/multicast.rs)
   * Extra trait for UDP sockets allowing subscription to multicast groups
+* [Readable](src/readable.rs)
+  * Extra trait for UDP, TCP and raw sockets allowing one to wait until the socket becomes readable
 
 ### Traits for sending/receiving raw ethernet payloads (a.k.a. raw sockets)
 
diff --git a/edge-raw/CHANGELOG.md b/edge-raw/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+* IO layer now implements the raw-networking traits from `edge-net`
diff --git a/edge-raw/Cargo.toml b/edge-raw/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-raw"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Async + `no_std` + no-alloc implementation of IP and UDP packet creation and parsing"
diff --git a/edge-ws/CHANGELOG.md b/edge-ws/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+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).
+
+## [0.3.0] - 2024-09-10
+* Migrated to the `edge-nal` traits
+* New method, `FrameHeader::mask_with` that takes a user-supplied mask
diff --git a/edge-ws/Cargo.toml b/edge-ws/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "edge-ws"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.77"
 description = "Async + `no_std` + no-alloc implementation of the Websockets protocol"
