refactor: rename rkyv 08 Archived types to avoid clash with rkyv 07 ones

Author: sdd

.github/workflows/build.yml

@@ -68,7 +68,7 @@ jobs:
       - uses: LoliGothick/clippy-check@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          options: --features=serde,rkyv_08,test_utils --no-deps
+          options: --features=serde,rkyv,rkyv_08,test_utils --no-deps
           name: Clippy (stable)
 
       - name: Check Rustdoc Links
@@ -105,14 +105,8 @@ jobs:
       - uses: LoliGothick/clippy-check@master
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          options: --features tracing,fixed,f16,rkyv,serde --no-deps
-          name: Clippy (nightly, rkyv 0.7)
-
-      - uses: LoliGothick/clippy-check@master
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          options: --features tracing,fixed,f16_rkyv_08,serde --no-deps
-          name: Clippy (nightly, rkyv 0.8)
+          options: --features tracing,fixed,rkyv,rkyv_08,serde --no-deps
+          name: Clippy nightly
 
       - name: Check Rustdoc Links
         run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
@@ -148,11 +142,8 @@ jobs:
           crate: cargo-hack
           version: "^0.6"
 
-      - name: Cargo check all targets and features (rkyv 0.7)
-        run: cargo hack check --workspace --each-feature --all-targets --exclude-features global_allocate,simd,rkyv_08,f16_rkyv_08
-
-      - name: Cargo check all targets and features (rkyv 0.8)
-        run: cargo hack check --workspace --each-feature --all-targets --exclude-features global_allocate,simd,rkyv,f16
+      - name: Cargo check all targets and features
+        run: cargo hack check --workspace --each-feature --all-targets --exclude-features global_allocate,simd
 
   check-unstable:
     name: Cargo Check (Nightly)
@@ -186,14 +177,12 @@ jobs:
           crate: cargo-hack
           version: "^0.6"
 
-      - name: Cargo check all targets and features (rkyv 0.7)
-        run: cargo hack check --workspace --each-feature --all-targets --exclude-features rkyv_08,f16_rkyv_08
+      - name: Cargo check all targets and features
+        run: cargo hack check --workspace --each-feature --all-targets
 
-      - name: Cargo check all targets and features (rkyv 0.8)
-        run: cargo hack check --workspace --each-feature --all-targets --exclude-features rkyv,f16
 
   test-basic:
-    name: Run Tests (Stable, no crate features enabled that require unstable Rust, Rkyv 0.7)
+    name: Run Tests (Stable, no crate features enabled that require unstable Rust)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -221,41 +210,12 @@ jobs:
         run: |
           cargo run --example build-float-doctest-tree --features="rkyv"
           cargo run --example build-immutable-doctest-tree --features="rkyv"
-          cargo test --workspace --features=serde,rkyv,test_utils
+          cargo run --example build-float-doctest-tree-rkyv_08 --features="rkyv_08"
+          cargo run --example build-immutable-doctest-tree-rkyv_08 --features="rkyv_08"
+          cargo test --workspace --features=serde,rkyv,rkyv_08,test_utils
 
-  test-basic-rkyv-08:
-    name: Run Tests (Stable, no crate features enabled that require unstable Rust, Rkyv 0.8)
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        show-progress: false
-
-    - name: Get latest stable Rust version
-      run: |
-        echo "LATEST_STABLE_RUST_VERSION=$(gh api /repos/rust-lang/rust/releases --jq ".[0].tag_name")" >> "$GITHUB_ENV"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Cache Toolchain
-      uses: actions/cache@v4
-      with:
-        path: ~/.rustup
-        key: toolchain-x86-64-${{ env.LATEST_STABLE_RUST_VERSION }}
-
-    - name: Install `stable` Toolchain
-      uses: actions-rust-lang/setup-rust-toolchain@v1
-      with:
-        components: rustfmt,clippy
-
-    - name: Cargo test
-      run: |
-        cargo run --example build-float-doctest-tree-rkyv_08 --features="rkyv_08"
-        cargo run --example build-immutable-doctest-tree-rkyv_08 --features="rkyv_08"
-        cargo test --workspace --features=serde,rkyv_08,test_utils
-
-  test-all-features-rkyv-07:
-    name: Run Tests (Nightly, all features enabled except `rkyv_08`)
+  test-all-features:
+    name: Run Tests (Nightly, all features enabled)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -284,52 +244,16 @@ jobs:
         run: |
           cargo run --example build-float-doctest-tree --features="rkyv"
           cargo run --example build-immutable-doctest-tree --features="rkyv"
-          cargo test --workspace --features "csv,f16,las,serde,simd,rkyv,test_utils,tracing"
-
-      - name: Cargo test (release build)
-        env:
-          RUSTFLAGS: '-C target-cpu=native'
-        run: |
-          cargo run --example build-float-doctest-tree --features="rkyv"
-          cargo run --example build-immutable-doctest-tree --features="rkyv"
-          cargo test --workspace --features "csv,f16,las,serde,simd,rkyv,test_utils,tracing" --release
-
-  test-all-features-rkyv-08:
-    name: Run Tests (Nightly, all features enabled except `rkyv` to allow rkyv 0.8 support)
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          show-progress: false
-
-      - name: Get date
-        run: |
-          echo "TODAY_DATE=$(date -Idate)" >> "$GITHUB_ENV"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Cache Toolchain
-        uses: actions/cache@v4
-        with:
-          path: ~/.rustup
-          key: toolchain-x86-64-nightly-${{ env.TODAY_DATE }}
-
-      - name: Install `nightly` Toolchain
-        uses: actions-rust-lang/setup-rust-toolchain@v1
-        with:
-          toolchain: nightly
-          components: rustfmt,clippy
-
-      - name: Cargo test (dev build)
-        run: |
           cargo run --example build-float-doctest-tree-rkyv_08 --features="rkyv_08"
           cargo run --example build-immutable-doctest-tree-rkyv_08 --features="rkyv_08"
-          cargo test --workspace --features "csv,f16_rkyv_08,las,serde,simd,rkyv_08,test_utils,tracing"
+          cargo test --workspace --features "csv,f16,las,serde,simd,rkyv,rkyv_08,test_utils,tracing"
 
       - name: Cargo test (release build)
         env:
           RUSTFLAGS: '-C target-cpu=native'
         run: |
+          cargo run --example build-float-doctest-tree --features="rkyv"
+          cargo run --example build-immutable-doctest-tree --features="rkyv"
           cargo run --example build-float-doctest-tree-rkyv_08 --features="rkyv_08"
           cargo run --example build-immutable-doctest-tree-rkyv_08 --features="rkyv_08"
-          cargo test --workspace --features "csv,f16_rkyv_08,las,serde,simd,rkyv_08,test_utils,tracing" --release
+          cargo test --workspace --features "csv,f16,las,serde,simd,rkyv,rkyv_08,test_utils,tracing" --release

.github/workflows/coverage.yml

@@ -40,7 +40,8 @@ jobs:
       - name: Generate Coverage
         run: |
           cargo run --example build-immutable-doctest-tree-rkyv_08 --features="rkyv_08"
-          cargo llvm-cov --features "csv,f16_rkyv_08,las,serde,simd,rkyv_08,test_utils,tracing" --tests --ignore-run-fail --workspace --codecov --output-path codecov.json
+          cargo run --example build-immutable-doctest-tree --features="rkyv"
+          cargo llvm-cov --features "csv,las,serde,simd,rkyv,rkyv_08,test_utils,tracing" --tests --ignore-run-fail --workspace --codecov --output-path codecov.json
 
       - uses: codecov/codecov-action@v5
         with:

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Kiddo Changelog
 
-## [5.1.0] - 2025-06-20
+## [5.2.0] - 2025-06-29
 
 It's been a while since the last release as my focus has been elsewhere, but I'm back in the k-d tree groove now
 and looking to bring some new features and performance updates over the next few weeks.
@@ -12,20 +12,17 @@ Right now, the pre-existing `rkyv` crate feature still provides support for
 Rkyv 0.7 as before, and so the introduction of Rkyv 0.8 is non-breaking. To use Rkyv 0.8, enable the crate feature that is 
 unsurprisingly named `rkyv_08`. There are some caveats to Rkyv 0.8 support:
 
-* Use of `rkyv` and `rkyv_08` is mutually exclusive; due to limitations in Rkyv's derive macros and trait system, it seems
-  impossible to support both at the same time. You may be able to achieve this to a limited extent by importing two versions of Kiddo
-  at the same time, one with `rkyv` activated and the other with `rkyv_08`, but interop between the two will be limited
+* The rkyv 0.8.x Archived structs are prefixed with `ArchivedR8` rather than `Archived` to avoid clashing with the pre-existing
+  rkyv 0.7 types.
 * You're unlikely to be able to successfully deserialize a tree serialized with Rkyv 0.7 into an Rkyv 0.8 object, and vice-versa.
 * Anyone using `rkyv` and `f16` / `half` at the same time may encounter issues updating to Rkyv 0.8. This is because the `half`
-  crate, on which Kiddo's f16 support depends, only supports Rkyv 0.7 at version 2.4.1 and below, and only supports Rkyv 0.8 at versions
-  2.5.0+. To use f16 in Kiddo with Rkyv 0.8, you need to enable the `f16_rkyv_08` crate feature to ensure that the correct versions
-  of both Rkyv and half are pulled in.
-* Supporting both Rkyv 0.7 and 0.8 in the Kiddo library at the same time is a massive pain and will add significant maintenance burden
-  going forward. As such, **this 5.1.0 version will be the only one that supports both Rkyv 0.7 and Rkyv 0.8. An upcoming version 6
-  of Kiddo will remove support for Rkyv 0.7 entirely and only support Rkyv 0.8.**
-
-All the best! Scott (@sdd)
-
+  crate only supports Rkyv 0.7 at version 2.4.1 and below, and only supports Rkyv 0.8 at versions
+  2.5.0+.
+* Supporting both Rkyv 0.7 and 0.8 in the Kiddo crate at the same time is a massive pain and will add significant maintenance burden
+  going forward. As such, **this 5.2.0 version will be the only one that supports both Rkyv 0.7 and Rkyv 0.8. An upcoming version 6
+  of Kiddo will remove support for Rkyv 0.7 entirely and only support Rkyv 0.8.** At this point the annoying non-standard `ArchivedR8`
+  prefix for the rkyv 0.8 types will be dropped in favour of the default naming scheme.
+* 
 ### ✨ Features
 
 - Add support for Rkyv v0.8
@@ -54,6 +51,16 @@ All the best! Scott (@sdd)
 - Update formatting to comply with updated clippy rules of recent versions of Rust
 - Update rust crate ordered-float to v5
 
+All the best! Scott (@sdd)
+
+## [5.1.0] - 2025-06-20: **YANKED**
+
+5.1.0 was yanked. It only supported Rkyv 0.7 and 0.8 in a mutually exclusive way, but I found a way to support both simultaneously
+a few days after publishing 5.1.0. This came at the expense of being a breaking change to 5.1.0, and to respect semver I'd have needed
+to release a 6.0.0 version that would have been immediately superseded by 7.0.0 that removed rkyv 0.7. Since 5.1.0 had only been out
+for a couple of days, and since the mutual exclusivity meant that the rkyv 0.8 structs were not even mentioned in the 5.1.0
+docs on docs.rs, I chose to yank 5.1.0 instead.
+
 ## [5.0.3] - 2024-12-21
 
 ### Deps
@@ -119,7 +126,8 @@ See `immutable-rkyv-serialize` and `immutable-rkyv-deserialize` in the examples
 **BREAKING CHANGE**: It was pointed out in https://github.com/sdd/kiddo/issues/159 that it was necessary to enable both `rkyv` and `serialize_rkyv` features to use Rkyv serialization. I took the opportunity of the major version bump to rationalize the feature names to make them easier to use.
 `serialize_rkyv` has been removed and now only `rkyv` feature is needed to enable Rkyv serialization.
 `serialize` has been renamed to `serde` in line with ecosystem conventions.
-`half` has been renamed to `f16` for clarity.
+`half` has been renamed to `f16` for clarity (but is not needed for `f16` support anyway and is only used to ensure that the `half` crate is only
+depended upon within the "half" examples and not as a core dependency)
 
 ### `max_qty` Changed to `NonZero<usize>`
 

Cargo.toml

@@ -70,17 +70,10 @@ optional = true
 
 # half 2.5.0 switched from rkyv 0.7 to rkyv 0.8.
 [dependencies.half]
-version = "<=2.4.1"
+version = "=2.4.1"
 optional = true
 features = ["num-traits"]
 
-# half 2.5.0 switched from rkyv 0.7 to rkyv 0.8.
-[dependencies.half_2_5]
-package = "half"
-version = "2.5"
-optional = true
-features = ["num-traits", "rkyv"]
-
 [dependencies.las]
 version = "0.9"
 optional = true
@@ -136,7 +129,6 @@ csv = ["dep:csv"]
 default = ["tracing", "fixed"]
 modified_van_emde_boas = []
 f16 = ["dep:half"]
-f16_rkyv_08 = ["dep:half_2_5", "rkyv_08"]
 fixed = ["dep:fixed"]
 global_allocate = []
 las = ["dep:las"]
@@ -237,11 +229,6 @@ name = "half"
 path = "examples/half.rs"
 required-features = ["f16"]
 
-[[example]]
-name = "half_rkyv_08"
-path = "examples/half_rkyv_08.rs"
-required-features = ["f16_rkyv_08"]
-
 [[example]]
 name = "immutable-large"
 path = "examples/immutable-large.rs"

README.md

@@ -19,8 +19,8 @@ Kiddo provides:
  - Its standard floating point k-d tree, exposed as [`kiddo::KdTree`](`crate::KdTree`)
  - An [`ImmutableKdTree`](`immutable::float::kdtree::ImmutableKdTree`) with space and performance advantages over the standard
    k-d tree, for situations where the tree does not need to be modified after creation
- - **Integer / fixed point support** via the [`Fixed`](https://docs.rs/fixed/latest/fixed/) library;
- - **`f16` support** via the [`half`](https://docs.rs/half/latest/half/) library; 
+ - **Integer / fixed point support** via the [`Fixed`](https://docs.rs/fixed/latest/fixed/) crate;
+ - **`f16` support** via the [`half`](https://docs.rs/half/latest/half/) crate; 
  - **Instant zero-copy deserialization** and serialization via [`Rkyv`](https://docs.rs/rkyv/latest/rkyv/) ([`Serde`](https://docs.rs/serde/latest/serde/) still available).
 
 ## Usage

examples/float-rkyv_08-deserialize.rs

@@ -11,7 +11,7 @@ use tracing_subscriber::fmt;
 
 use rkyv_08::rancor::Error as RkyvError;
 
-use kiddo::float::kdtree::ArchivedKdTree;
+use kiddo::float::kdtree::ArchivedR8KdTree;
 use kiddo::float::kdtree::KdTree;
 use kiddo::SquaredEuclidean;
 
@@ -116,7 +116,7 @@ where
 
         // Get archived tree
         let archived_tree =
-            rkyv_08::access::<ArchivedKdTree<f64, u32, 3, 32, u32>, RkyvError>(&buf[..]).unwrap();
+            rkyv_08::access::<ArchivedR8KdTree<f64, u32, 3, 32, u32>, RkyvError>(&buf[..]).unwrap();
         let loaded = Instant::now();
 
         println!("Tree Size: {}", archived_tree.size());
@@ -200,7 +200,7 @@ where
 
         // Get archived tree using unsafe method
         let archived_tree =
-            unsafe { rkyv_08::access_unchecked::<ArchivedKdTree<f64, u32, 3, 32, u32>>(&buf) };
+            unsafe { rkyv_08::access_unchecked::<ArchivedR8KdTree<f64, u32, 3, 32, u32>>(&buf) };
         let loaded = Instant::now();
 
         // perform a query using the wrapper

examples/half.rs

@@ -1,8 +1,4 @@
-#[cfg(all(
-    feature = "f16",
-    not(feature = "rkyv_08"),
-    not(feature = "f16_rkyv_08")
-))]
+#[cfg(feature = "f16")]
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     use half::f16;
     use kiddo::{KdTree, SquaredEuclidean};
@@ -32,9 +28,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
-#[cfg(any(not(feature = "f16"), feature = "f16_rkyv_08", feature = "rkyv_08"))]
+#[cfg(not(feature = "f16"))]
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    println!("Activate the 'f16' feature to run this example properly. Ensure that the 'f16_rkyv_08' and 'rkyv_80' features are disabled.");
+    println!("Activate the 'f16' feature to run this example properly.");
     println!("Try this: cargo run --example half --features=f16");
 
     Ok(())

examples/half_rkyv_08.rs

@@ -11,7 +11,7 @@ use tracing_subscriber::fmt;
 
 use rkyv_08::{access, access_unchecked, from_bytes_unchecked, rancor::Error as RkyvError};
 
-use kiddo::immutable::float::kdtree::ArchivedImmutableKdTree;
+use kiddo::immutable::float::kdtree::ArchivedR8ImmutableKdTree;
 use kiddo::immutable::float::kdtree::ImmutableKdTree;
 use kiddo::SquaredEuclidean;
 
@@ -115,7 +115,7 @@ where
 
         // Get archived tree
         let archived_tree =
-            access::<ArchivedImmutableKdTree<f64, u32, 3, 256>, RkyvError>(&buf[..]).unwrap();
+            access::<ArchivedR8ImmutableKdTree<f64, u32, 3, 256>, RkyvError>(&buf[..]).unwrap();
         let loaded = Instant::now();
 
         // perform a query using the wrapper
@@ -196,7 +196,7 @@ where
 
         // Get archived tree using unsafe method
         let archived_tree =
-            unsafe { access_unchecked::<ArchivedImmutableKdTree<f64, u32, 3, 256>>(&buf) };
+            unsafe { access_unchecked::<ArchivedR8ImmutableKdTree<f64, u32, 3, 256>>(&buf) };
         let loaded = Instant::now();
 
         // perform a query using the wrapper