Merge remote-tracking branch 'upstream/main' into remove-doc-auto-cfg-feature

Author: robamu

.github/workflows/build.yml

@@ -9,7 +9,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  RUSTFLAGS: '-D warnings'
+  RUSTFLAGS: "-D warnings"
 
 jobs:
   # Run MIRI tests on nightly
@@ -48,7 +48,7 @@ jobs:
           components: miri
 
       - name: Run miri
-        run: MIRIFLAGS=-Zmiri-ignore-leaks cargo miri test
+        run: MIRIFLAGS=-Zmiri-ignore-leaks cargo miri test --features="alloc,defmt,mpmc_large,portable-atomic-critical-section,serde,ufmt,bytes,zeroize"
 
   # Run cargo test
   test:
@@ -84,7 +84,7 @@ jobs:
           toolchain: stable
 
       - name: Run cargo test
-        run: cargo test
+        run: cargo test --features="alloc,defmt,mpmc_large,portable-atomic-critical-section,serde,ufmt,bytes,zeroize"
 
   # Run cargo fmt --check
   style:
@@ -163,18 +163,26 @@ jobs:
 
       - name: cargo check
         run: |
-          cargo check --target=${{ matrix.target }}
-          cargo check --target=${{ matrix.target }} --features="portable-atomic-critical-section"
-          cargo check --target=${{ matrix.target }} --features="ufmt serde defmt-03 mpmc_large"
+          cargo check --target="${target}"
+          cargo check --target="${target}" --features="alloc"
+
+          # Needs native atomics, since `bytes` doesn't support `portable-atomic`.
+          if [ "${target}" != "riscv32imc-unknown-none-elf" ] && [ "${target}" != "thumbv6m-none-eabi" ]; then
+            cargo check --target="${target}" --features="bytes"
+          fi
+
+          cargo check --target="${target}" --features="defmt"
+          cargo check --target="${target}" --features="mpmc_large"
+          cargo check --target="${target}" --features="portable-atomic-critical-section"
+          cargo check --target="${target}" --features="serde"
+          cargo check --target="${target}" --features="ufmt"
+          cargo check --target="${target}" --features="zeroize"
+        env:
+          target: ${{ matrix.target }}
 
   doc:
     name: doc
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        target:
-          - x86_64-unknown-linux-gnu
-          - thumbv7m-none-eabi
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -201,14 +209,40 @@ jobs:
             ${{ runner.OS }}-build-${{ hashFiles('**/Cargo.lock') }}
             ${{ runner.OS }}-build-
 
-      - name: Install nightly Rust with target (${{ matrix.target }})
+      - name: Get metadata
+        id: metadata
+        run: |
+          set -euo pipefail
+
+          docsrs_metadata="$(cargo metadata --format-version 1 | jq '.packages[] | select(.name == "heapless") | .metadata.docs.rs')"
+          features=($(jq --raw-output '.features[]' <<< "${docsrs_metadata}"))
+          rustdocflags=(-D warnings --cfg docsrs $(jq --raw-output '.["rustdoc-args"][]' <<< "${docsrs_metadata}"))
+          targets=($(jq --raw-output '.targets[]' <<< "${docsrs_metadata}"))
+
+          echo "features=${features[*]}" >> "${GITHUB_OUTPUT}"
+          echo "rustdocflags=${rustdocflags[*]}" >> "${GITHUB_OUTPUT}"
+          echo "targets=${targets[*]}" >> "${GITHUB_OUTPUT}"
+
+      - name: Install nightly Rust with targets (${{ steps.metadata.outputs.targets }})
         uses: dtolnay/rust-toolchain@nightly
         with:
-          targets: ${{ matrix.target }}
+          targets: ${{ steps.metadata.outputs.targets }}
 
       - name: cargo rustdoc
-        env: {"RUSTDOCFLAGS": "-D warnings --cfg docsrs"}
-        run: cargo rustdoc --target=${{ matrix.target }} --features="ufmt serde defmt-03 mpmc_large portable-atomic-critical-section"
+        run: |
+          set -euo pipefail
+
+          targets=(${targets})
+
+          for target in "${targets[@]}"; do
+            set -x
+            cargo rustdoc --target "${target}" --features "${features}"
+            set +x
+          done
+        env:
+          features: ${{ steps.metadata.outputs.features }}
+          RUSTDOCFLAGS: ${{ steps.metadata.outputs.rustdocflags }}
+          targets: ${{ steps.metadata.outputs.targets }}
 
   # Run cpass tests
   testcpass:
@@ -255,7 +289,7 @@ jobs:
           targets: ${{ matrix.target }}
 
       - name: cargo test
-        run: cargo test --test cpass --target=${{ matrix.target }} --features=serde ${{ matrix.buildtype }}
+        run: cargo test --test cpass --target=${{ matrix.target }} ${{ matrix.buildtype }}
 
   # Run test suite for UI
   testtsan:
@@ -312,6 +346,9 @@ jobs:
   testcfail:
     name: testcfail
     runs-on: ubuntu-latest
+    env:
+      RUSTFLAGS: -D warnings
+      MSRV: 1.87.0
     defaults:
       run:
         working-directory: cfail
@@ -341,7 +378,9 @@ jobs:
             ${{ runner.OS }}-build-
 
       - name: Install Rust
-        uses: dtolnay/rust-toolchain@stable
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ env.MSRV }}
 
       - name: Run cargo
         run: cargo run

CHANGELOG.md

@@ -7,8 +7,45 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- Minor fixes to module docs.
+- Make MSRV of 1.87.0 explicit.
+- Implement `Default` for `CapacityError`.
+- Implement `defmt::Format` for `CapacityError`.
+- Implement `TryFrom` for `Deque` from array.
+- Switch from `serde` to `serde_core` for enabling faster compilations.
+- Implement `Zeroize` trait for all data structures with the `zeroize` feature to securely clear sensitive data from memory.
+
+## [v0.9.1] - 2025-08-19
+
+### Added
+
+- Added `String::insert` and `String::insert_str`.
+
+### Changed
+
+- `bytes::BufMut` is now implemented on `VecInner`.
+- Removed generic from `history_buf::OldestOrdered`.
+- Made `LenType` opt-in.
+- Minor fixes to `pool::boxed` docs.
+- Add missing `Debug` derive to `vec::IntoIter`.
+- Removed generic from `spsc::Consumer`, `spsc::Producer` and `spsc::Iter`.
+
+### Fixed
+
+- CI now uses flags specified in `Cargo.toml` for `rustdoc` tests.
+- Fixed clippy lints.
+- Fixed the memory layout of the internal `UnionNode<T>` type, fixing possible Undefined Behaviour.
+
+### Removed
+
+- Removed invalid `bytes::Buf` implementation.
+- Removed `DefaultLenType` struct.
+
+## [v0.9.0] - 2025-04-28 [YANKED]
+
 ### Added
 
+- Added `bytes::Buf` and `bytes::BufMut` implementations for `Vec`.
 - Added `format` macro.
 - Added `String::from_utf16`.
 - Added `is_full`, `recent_index`, `oldest`, and `oldest_index` to `HistoryBuffer`
@@ -40,13 +77,67 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added implementation of `Borrow` and `BorrowMut` for `String` and `Vec`.
 - Added `Deque::{swap, swap_unchecked, swap_remove_front, swap_remove_back}`.
 - Make `String::from_utf8_unchecked` const.
+- Implemented `PartialEq` and `Eq` for `Deque`.
+- Added `alloc` feature to enable `alloc`-Vec interoperability.
+- Added `TryFrom<alloc::vec::Vec>` impl for `Vec`.
+- Added `TryFrom<Vec>` impl for `alloc::vec::Vec`.
+- Added `truncate` to `IndexMap`.
+- Added `get_index` and `get_index_mut` to `IndexMap`.
+- Added `String::uDisplay`.
+- Added `CString`.
+- Added `LenT` generic to `Vec<T, N>` and `VecView<T>` to save memory when using a sane capacity value.
+- Added the `index_set` module.
+- Added the `index_map` module.
+- Migrated `Idx` generic for `SortedLinkedList` to use the new `LenType` trait, allowing for `Idx` inference.
+- Added similar `LenT` generic to `String`.
+- Optimize size of zero capacity `Vec<T, 0>` to be 0 bytes
 
 ### Changed
 
+- Updated defmt from 0.3 to 1.0.1
+  - Changed the feature name from `defmt-03` to `defmt`.
+- Changed the error type of these methods from `()` to `CapacityError`.
+  - `String::push_str`
+  - `String::push`
+  - `Vec::extend_from_slice`
+  - `Vec::from_slice`
+  - `Vec::resize_default`
+  - `Vec::resize`
+- Renamed `FromUtf16Error::DecodeUtf16Error` to `FromUtf16Error::DecodeUtf16`.
 - Changed `stable_deref_trait` to a platform-dependent dependency.
+- Changed `SortedLinkedList::pop` return type from `Result<T, ()>` to `Option<T>` to match `std::vec::pop`.
+- `Vec::capacity` is no longer a `const` function.
+- Relaxed bounds on `PartialEq` for `IndexMap` from `V: Eq` to `V1: PartialEq<V2>`.
+- Relaxed bounds on `PartialEq` for `LinearMap` from `V: PartialEq` to `V1: PartialEq<V2>`.
+- The `FnvIndexSet` type is now inside the `index_set` module.
+- The `IndexSetIter` type is now inside the `index_set` module and has been renamed to `Iter`.
+- The `Bucket` type is now inside the `index_map` module.
+- The `Entry` type is now inside the `index_map` module.
+- The `FnvIndexMap` type is now inside the `index_map` module.
+- The `IndexMapIter` type is now inside the `index_map` module and has been renamed to `Iter`.
+- The `IndexMapIterMut` type is now inside the `index_map` module and has been renamed to `IterMut`.
+- The `IndexMapKeys` type is now inside the `index_map` module and has been renamed to `Keys`.
+- The `OccupiedEntry` type is now inside the `index_map` module.
+- The `Pos` type is now inside the `index_map` module.
+- The `VacantEntry` type is now inside the `index_map` module.
+- The `VacantEntry` type is now inside the `index_map` module.
+- The `IndexMapValues` type is now inside the `index_map` module and has been renamed to `Values`.
+- The `IndexMapValuesMut` type is now inside the `index_map` module and has been renamed to `ValuesMut`.
+- The `histbuf` module has been renamed to `history_buf`.
+- The `HistoryBuffer` type has been renamed to `HistoryBuf`.
+- The `HistoryBufferView` type has been renamed to `HistoryBufView`.
+- The `OwnedHistBufStorage` type has been renamed to `OwnedHistoryBufStorage`.
+- The `ViewHistBufStorage` type has been renamed to `ViewHistoryBufStorage`.
+- The `MpMcQueue` type has been renamed to `Queue`.
+- The `MpMcQueueView` type has been renamed to `QueueView`.
+- The `MpMcQueueInner` type has been renamed to `QueueInner`.
+- Remove `Q*` type aliases for `MpMcQueue`, and rename it to just `Queue`
+- Changed `Queue::split` to be `const`.
 
 ### Fixed
 
+- Fixed bug in `IndexMap::truncate` that left the map in an inconsistent state.
+- Fixed compilation on `thumbv6m-none-eabi` without `portable-atomic` feature.
 - Fixed clippy lints.
 - Fixed `{arc,box,object}_pool!` emitting clippy lints.
 - Fixed the list of implemented data structures in the crate docs, by adding `Deque`,
@@ -58,6 +149,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - `doc_auto_cfg` feature which was merged into `doc_cfg`. Presence of the feature led to doc
   build failures on nightly.
+- `Vec::storage_capacity` has been removed and `Vec::capacity` must be used instead.
+- Removed `sorted_linked_list::Iter` and `sorted_linked_list::IterInner`.
+- Removed `sorted_linked_list::FindMut` and `sorted_linked_list::FindMutInner`.
+- The `Q2`, `Q4`, `Q8`, `Q16`, `Q32` and `Q64` aliases for `MpMcQueue` have been removed.
 
 ## [v0.8.0] - 2023-11-07
 
@@ -94,6 +189,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   - `ufmt-impl` is now `ufmt`
   - `cas` is removed, atomic polyfilling is now opt-in via the `portable-atomic` feature.
 - `Vec::as_mut_slice` is now a public method.
+- `ufmt` functions are annotated with `inline`.
 
 ### Fixed
 
@@ -615,7 +711,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release
 
-[Unreleased]: https://github.com/rust-embedded/heapless/compare/v0.8.0...HEAD
+[Unreleased]: https://github.com/rust-embedded/heapless/compare/v0.9.1...HEAD
+[v0.9.1]: https://github.com/rust-embedded/heapless/compare/v0.9.0...v0.9.1
+[v0.9.0]: https://github.com/rust-embedded/heapless/compare/v0.8.0...v0.9.0
 [v0.8.0]: https://github.com/rust-embedded/heapless/compare/v0.7.16...v0.8.0
 [v0.7.16]: https://github.com/rust-embedded/heapless/compare/v0.7.15...v0.7.16
 [v0.7.15]: https://github.com/rust-embedded/heapless/compare/v0.7.14...v0.7.15

Cargo.toml

@@ -1,63 +1,91 @@
 [package]
 authors = [
-  "Jorge Aparicio <[email protected]>",
-  "Per Lindgren <[email protected]>",
-  "Emil Fresk <[email protected]>",
+    "Jorge Aparicio <[email protected]>",
+    "Per Lindgren <[email protected]>",
+    "Emil Fresk <[email protected]>",
 ]
 categories = ["data-structures", "no-std"]
 description = "`static` friendly data structures that don't require dynamic memory allocation"
 documentation = "https://docs.rs/heapless"
 edition = "2021"
+rust-version = "1.87"
 keywords = ["static", "no-heap"]
 license = "MIT OR Apache-2.0"
 name = "heapless"
 repository = "https://github.com/rust-embedded/heapless"
-version = "0.8.0"
+version = "0.9.1"
 
 [features]
+bytes = ["dep:bytes"]
+
 # Enable polyfilling of atomics via `portable-atomic`.
 # `portable-atomic` polyfills some functionality by default, but to get full atomics you must
 # enable one of its features to tell it how to do it. See `portable-atomic` documentation for details.
 portable-atomic = ["dep:portable-atomic"]
 
 # Enable polyfilling of atomics via portable-atomic, using critical section for locking
-portable-atomic-critical-section = ["dep:portable-atomic", "portable-atomic", "portable-atomic?/critical-section"]
+portable-atomic-critical-section = [
+    "dep:portable-atomic",
+    "portable-atomic",
+    "portable-atomic?/critical-section",
+]
 
 # Enable polyfilling of atomics via portable-atomic, using disabling interrupts for locking.
 # WARNING: this is only sound for single-core bare-metal privileged-mode targets!
-portable-atomic-unsafe-assume-single-core = ["dep:portable-atomic", "portable-atomic", "portable-atomic?/unsafe-assume-single-core"]
+portable-atomic-unsafe-assume-single-core = [
+    "dep:portable-atomic",
+    "portable-atomic",
+    "portable-atomic?/unsafe-assume-single-core",
+]
 
 # implement serde traits.
-serde = ["dep:serde"]
+serde = ["dep:serde_core"]
 
 # implement ufmt traits.
-ufmt = ["dep:ufmt-write"]
+ufmt = ["dep:ufmt", "dep:ufmt-write"]
 
-# Implement defmt::Format from defmt v0.3
-defmt-03 = ["dep:defmt"]
+# Implement `defmt::Format`.
+defmt = ["dep:defmt"]
+
+# Implement `zeroize::Zeroize` trait.
+zeroize = ["dep:zeroize"]
 
 # Enable larger MPMC sizes.
 mpmc_large = []
 
+# Implement some alloc Vec interoperability
+alloc = []
+
 nightly = []
 
 [dependencies]
+bytes = { version = "1", default-features = false, optional = true }
 portable-atomic = { version = "1.0", optional = true }
 hash32 = "0.3.0"
-serde = { version = "1", optional = true, default-features = false }
+serde_core = { version = "1", optional = true, default-features = false }
+ufmt = { version = "0.2", optional = true }
 ufmt-write = { version = "0.1", optional = true }
-defmt = { version = ">=0.2.0,<0.4", optional = true }
+defmt = { version = "1.0.1", optional = true }
+zeroize = { version = "1.8", optional = true, default-features = false, features = ["derive"] }
 
 # for the pool module
 [target.'cfg(any(target_arch = "arm", target_pointer_width = "32", target_pointer_width = "64"))'.dependencies]
 stable_deref_trait = { version = "1", default-features = false }
 
 [dev-dependencies]
-ufmt = "0.2"
+critical-section = { version = "1.1", features = ["std"] }
 static_assertions = "1.1.0"
 
 [package.metadata.docs.rs]
-features = ["ufmt", "serde", "defmt-03", "mpmc_large", "portable-atomic-critical-section"]
+features = [
+    "bytes",
+    "ufmt",
+    "serde",
+    "defmt",
+    "mpmc_large",
+    "portable-atomic-critical-section",
+    "alloc",
+]
 # for the pool module
 targets = ["i686-unknown-linux-gnu"]
 rustdoc-args = ["--cfg", "docsrs"]

README.md

@@ -32,6 +32,11 @@ Licensed under either of
 
 at your option.
 
+## MSRV Policy
+
+This crate is guaranteed to compile with the latest two stable releases of Rust. For example, if the
+latest stable Rust release is 1.70, then this crate is guaranteed to compile with Rust 1.69 and 1.70.
+
 ## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted