Future-proof external crate compatibility

Author: novacrazy

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
           - bytecheck
         external:
           - ''
-          - hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe
+          - hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1
 
     steps:
       - uses: actions/checkout@v4

.vscode/settings.json

@@ -1,15 +1,15 @@
 {
   "rust-analyzer.cargo.features": [
-    "hashbrown",
-    "indexmap",
-    "smallvec",
-    "smol_str_02",
-    "smol_str_03",
-    "arrayvec",
-    "tinyvec",
-    "uuid",
-    "bytes",
-    "thin-vec",
-    "triomphe",
+    "arrayvec-0_7",
+    "bytes-1",
+    "hashbrown-0_14",
+    "indexmap-2",
+    "smallvec-1",
+    "smol_str-0_2",
+    "smol_str-0_3",
+    "thin-vec-0_2",
+    "tinyvec-1",
+    "triomphe-0_1",
+    "uuid-1"
   ]
 }

release_checklist.md

@@ -50,17 +50,17 @@ cargo test --tests --no-default-features --features "big_endian unaligned pointe
 - none, `alloc`, `std`
 - none, `bytecheck`
 - none, all external crates
-  - `hashbrown`
-  - `indexmap`
-  - `smallvec`
-  - `smol_str_02`
-  - `smol_str_03`
-  - `arrayvec`
-  - `tinyvec`
-  - `uuid`
-  - `bytes`
-  - `thin-vec`
-  - `triomphe`
+  - `hashbrown-0_14`
+  - `indexmap-2`
+  - `smallvec-1`
+  - `smol_str-0_2`
+  - `smol_str-0_3`
+  - `arrayvec-0_7`
+  - `tinyvec-1`
+  - `uuid-1`
+  - `bytes-1`
+  - `thin-vec-0_2`
+  - `triomphe-0_1`
 
 Builds:
 
@@ -71,12 +71,12 @@ cargo test --tests --no-default-features --features "std" >> results.txt~
 cargo test --tests --no-default-features --features "bytecheck" >> results.txt~
 cargo test --tests --no-default-features --features "bytecheck alloc" >> results.txt~
 cargo test --tests --no-default-features --features "bytecheck std" >> results.txt~
-cargo test --tests --no-default-features --features "hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
-cargo test --tests --no-default-features --features "alloc hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
-cargo test --tests --no-default-features --features "std hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
-cargo test --tests --no-default-features --features "bytecheck hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
-cargo test --tests --no-default-features --features "bytecheck alloc hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
-cargo test --tests --no-default-features --features "bytecheck std hashbrown indexmap smallvec smol_str_02 smol_str_03 arrayvec tinyvec uuid bytes thin-vec triomphe" >> results.txt~
+cargo test --tests --no-default-features --features "hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
+cargo test --tests --no-default-features --features "alloc hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
+cargo test --tests --no-default-features --features "std hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
+cargo test --tests --no-default-features --features "bytecheck hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
+cargo test --tests --no-default-features --features "bytecheck alloc hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
+cargo test --tests --no-default-features --features "bytecheck std hashbrown-0_14 indexmap-2 smallvec-1 smol_str-0_2 smol_str-0_3 arrayvec-0_7 tinyvec-1 uuid-1 bytes-1 thin-vec-0_2 triomphe-0_1" >> results.txt~
 ```
 
 # Testing through MIRI

rkyv/Cargo.toml

@@ -31,17 +31,18 @@ rkyv_derive.workspace = true
 # Before adding support for another crate, please consider getting rkyv support
 # in the crate instead.
 
-arrayvec = { version = "0.7", optional = true, default-features = false }
-bytes = { version = "1.4.0", optional = true, default-features = false }
-# hashbrown
-indexmap = { version = "2.2", optional = true, default-features = false }
-smallvec = { version = "1.7", optional = true, default-features = false }
-smol_str_02 = { version = "0.2", package = "smol_str", optional = true, default-features = false }
-smol_str_03 = { version = "0.3", package = "smol_str", optional = true, default-features = false }
-thin-vec = { version = "0.2.12", optional = true, default-features = false }
-tinyvec = { version = "1.5", optional = true, default-features = false }
-triomphe = { version = "0.1", optional = true, default-features = false }
-uuid = { version = "1.3", optional = true, default-features = false }
+arrayvec-0_7 = { package = "arrayvec", version = "0.7", optional = true, default-features = false }
+bytes-1 = { package = "bytes", version = "1", optional = true, default-features = false }
+# rkyv already depends on hashbrown 0.14, so we can't duplicate this, but we can expose it as a feature below
+# hashbrown-0_14 = { package = "hashbrown", version = "0.14", optional = true, default-features = false }
+indexmap-2 = { package = "indexmap", version = "2", optional = true, default-features = false }
+smallvec-1 = { package = "smallvec", version = "1", optional = true, default-features = false }
+smol_str-0_2 = { package = "smol_str", version = "0.2", optional = true, default-features = false }
+smol_str-0_3 = { package = "smol_str", version = "0.3", optional = true, default-features = false }
+thin-vec-0_2 = { package = "thin-vec", version = "0.2.12", optional = true, default-features = false }
+tinyvec-1 = { package = "tinyvec", version = "1", optional = true, default-features = false }
+triomphe-0_1 = { package = "triomphe", version = "0.1", optional = true, default-features = false }
+uuid-1 = { package = "uuid", version = "1", optional = true, default-features = false }
 
 [features]
 default = ["std", "bytecheck"]
@@ -52,15 +53,15 @@ unaligned = []
 pointer_width_16 = []
 pointer_width_32 = []
 pointer_width_64 = []
-alloc = ["dep:hashbrown", "tinyvec?/alloc", "rancor/alloc"]
-std = ["alloc", "bytes?/std", "indexmap?/std", "ptr_meta/std", "uuid?/std"]
+alloc = ["dep:hashbrown", "tinyvec-1?/alloc", "rancor/alloc"]
+std = ["alloc", "bytes-1?/std", "indexmap-2?/std", "ptr_meta/std", "uuid-1?/std"]
 bytecheck = ["dep:bytecheck", "rend/bytecheck", "rkyv_derive/bytecheck"]
 
 # External crate support
-hashbrown = ["dep:hashbrown"]
-indexmap = ["dep:indexmap", "alloc"]
-triomphe = ["dep:triomphe", "alloc"]
-uuid = ["dep:uuid", "bytecheck?/uuid"]
+hashbrown-0_14 = ["dep:hashbrown"]
+indexmap-2 = ["dep:indexmap-2", "alloc"]
+triomphe-0_1 = ["dep:triomphe-0_1", "alloc"]
+uuid-1 = ["dep:uuid-1", "bytecheck?/uuid"]
 
 [package.metadata.docs.rs]
 features = ["bytecheck"]

rkyv/src/impls/arrayvec.rs rkyv/src/impls/ext/arrayvec_0_7.rs

@@ -1,4 +1,4 @@
-use arrayvec::ArrayVec;
+use arrayvec_0_7::ArrayVec;
 use rancor::Fallible;
 
 use crate::{
@@ -77,8 +77,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use arrayvec::ArrayVec;
-
+    use super::ArrayVec;
     use crate::api::test::roundtrip_with;
 
     #[test]

rkyv/src/impls/bytes.rs rkyv/src/impls/ext/bytes_1.rs

@@ -1,4 +1,4 @@
-use bytes::{Bytes, BytesMut};
+use bytes_1::{Bytes, BytesMut};
 use rancor::Fallible;
 
 use crate::{
@@ -36,7 +36,7 @@ impl<D: Fallible + ?Sized> Deserialize<Bytes, D> for ArchivedVec<Archived<u8>> {
 
 impl<T: Archive> PartialEq<Bytes> for ArchivedVec<T>
 where
-    bytes::Bytes: PartialEq<[T]>,
+    Bytes: PartialEq<[T]>,
 {
     fn eq(&self, other: &Bytes) -> bool {
         other == self.as_slice()
@@ -45,8 +45,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use bytes::Bytes;
-
+    use super::Bytes;
     use crate::{alloc::vec, api::test::roundtrip};
 
     #[test]

rkyv/src/impls/hashbrown/hash_map.rs rkyv/src/impls/ext/hashbrown_0_14/hash_map.rs

@@ -0,0 +1,6 @@
+mod hash_map;
+mod hash_set;
+mod with;
+
+// NOTE: When hashbrown updates to 0.15 or later,
+// this module will need to be updated to use hashbrown_0_14

rkyv/src/impls/hashbrown/hash_set.rs rkyv/src/impls/ext/hashbrown_0_14/hash_set.rs

@@ -1,6 +1,6 @@
 use core::hash::{BuildHasher, Hash};
 
-use indexmap::IndexMap;
+use indexmap_2::IndexMap;
 use rancor::{Fallible, Source};
 
 use crate::{
@@ -83,7 +83,7 @@ where
 mod tests {
     use core::hash::BuildHasherDefault;
 
-    use indexmap::IndexMap;
+    use indexmap_2::IndexMap;
 
     use crate::{
         alloc::string::String, api::test::roundtrip_with, hash::FxHasher64,

rkyv/src/impls/ext/hashbrown_0_14/mod.rs

@@ -1,6 +1,6 @@
 use core::hash::{BuildHasher, Hash};
 
-use indexmap::IndexSet;
+use indexmap_2::IndexSet;
 use rancor::{Fallible, Source};
 
 use crate::{
@@ -68,7 +68,7 @@ impl<UK, K: PartialEq<UK>, S: BuildHasher> PartialEq<IndexSet<UK, S>>
 mod tests {
     use core::hash::BuildHasherDefault;
 
-    use indexmap::IndexSet;
+    use indexmap_2::IndexSet;
 
     use crate::{
         alloc::string::String, api::test::roundtrip_with, hash::FxHasher64,

rkyv/src/impls/hashbrown/with.rs rkyv/src/impls/ext/hashbrown_0_14/with.rs

@@ -0,0 +1,30 @@
+// Support for various common crates. These are primarily to get users off the
+// ground and build some momentum.
+
+// These are NOT PLANNED to remain in rkyv for the final release. Much like
+// serde, these implementations should be moved into their respective crates
+// over time. Before adding support for another crate, please consider getting
+// rkyv support in the crate instead.
+
+#[cfg(feature = "arrayvec-0_7")]
+mod arrayvec_0_7;
+#[cfg(feature = "bytes-1")]
+mod bytes_1;
+#[cfg(feature = "hashbrown-0_14")]
+mod hashbrown_0_14;
+#[cfg(feature = "indexmap-2")]
+mod indexmap_2;
+#[cfg(feature = "smallvec-1")]
+mod smallvec_1;
+#[cfg(feature = "smol_str-0_2")]
+mod smolstr_0_2;
+#[cfg(feature = "smol_str-0_3")]
+mod smolstr_0_3;
+#[cfg(feature = "thin-vec-0_2")]
+mod thin_vec_0_2;
+#[cfg(feature = "tinyvec-1")]
+mod tinyvec_1;
+#[cfg(feature = "triomphe-0_1")]
+mod triomphe_0_1;
+#[cfg(feature = "uuid-1")]
+mod uuid_1;

rkyv/src/impls/indexmap/index_map.rs rkyv/src/impls/ext/indexmap_2/index_map.rs

@@ -1,5 +1,5 @@
 use rancor::Fallible;
-use smallvec::{Array, SmallVec};
+use smallvec_1::{Array, SmallVec};
 
 use crate::{
     ser::{Allocator, Writer},
@@ -80,7 +80,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use smallvec::{smallvec, SmallVec};
+    use smallvec_1::{smallvec, SmallVec};
 
     use crate::api::test::roundtrip_with;
 

rkyv/src/impls/indexmap/index_set.rs rkyv/src/impls/ext/indexmap_2/index_set.rs

@@ -1,5 +1,5 @@
 use rancor::{Fallible, Source};
-use smol_str_02::SmolStr;
+use smol_str_0_2::SmolStr;
 
 use crate::{
     ser::{Allocator, Writer},

rkyv/src/impls/indexmap/mod.rs rkyv/src/impls/ext/indexmap_2/mod.rs

@@ -1,5 +1,5 @@
 use rancor::{Fallible, Source};
-use smol_str_03::SmolStr;
+use smol_str_0_3::SmolStr;
 
 use crate::{
     ser::{Allocator, Writer},

rkyv/src/impls/ext/mod.rs

@@ -1,5 +1,5 @@
 use rancor::Fallible;
-use thin_vec::ThinVec;
+use thin_vec_0_2::ThinVec;
 
 use crate::{
     ser::{Allocator, Writer},
@@ -73,8 +73,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use thin_vec::ThinVec;
-
+    use super::ThinVec;
     use crate::api::test::roundtrip_with;
 
     #[test]

rkyv/src/impls/smallvec.rs rkyv/src/impls/ext/smallvec_1.rs

@@ -1,7 +1,7 @@
 use rancor::Fallible;
-#[cfg(all(feature = "tinyvec", feature = "alloc"))]
-use tinyvec::TinyVec;
-use tinyvec::{Array, ArrayVec, SliceVec};
+#[cfg(feature = "alloc")]
+use tinyvec_1::TinyVec;
+use tinyvec_1::{Array, ArrayVec, SliceVec};
 
 use crate::{
     ser::{Allocator, Writer},
@@ -84,7 +84,7 @@ where
 
 // TinyVec
 
-#[cfg(all(feature = "tinyvec", feature = "alloc"))]
+#[cfg(feature = "alloc")]
 impl<A: Array> Archive for TinyVec<A>
 where
     A::Item: Archive,
@@ -97,7 +97,7 @@ where
     }
 }
 
-#[cfg(all(feature = "tinyvec", feature = "alloc"))]
+#[cfg(feature = "alloc")]
 impl<A, S> Serialize<S> for TinyVec<A>
 where
     A: Array,
@@ -112,7 +112,7 @@ where
     }
 }
 
-#[cfg(all(feature = "tinyvec", feature = "alloc"))]
+#[cfg(feature = "alloc")]
 impl<A, D> Deserialize<TinyVec<A>, D> for ArchivedVec<Archived<A::Item>>
 where
     A: Array,
@@ -184,7 +184,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use tinyvec::{array_vec, Array, SliceVec};
+    use tinyvec_1::{array_vec, Array, SliceVec};
 
     use crate::api::test::{roundtrip_with, to_archived};
 
@@ -209,10 +209,10 @@ mod tests {
         });
     }
 
-    #[cfg(all(feature = "tinyvec", feature = "alloc"))]
+    #[cfg(feature = "alloc")]
     #[test]
     fn roundtrip_tiny_vec() {
-        use tinyvec::tiny_vec;
+        use tinyvec_1::tiny_vec;
 
         use crate::alloc::vec;
 

rkyv/src/impls/smolstr_02.rs rkyv/src/impls/ext/smolstr_0_2.rs

@@ -5,7 +5,7 @@ use core::{
 
 use ptr_meta::Pointee;
 use rancor::{Fallible, Source};
-use triomphe::Arc;
+use triomphe_0_1::Arc;
 
 use crate::{
     de::{Metadata, Pooling, PoolingExt, SharedPointer},
@@ -83,7 +83,7 @@ where
 
 #[cfg(test)]
 mod tests {
-    use triomphe::Arc;
+    use triomphe_0_1::Arc;
 
     use crate::api::test::roundtrip_with;