Merge #627

627: Add trait implementations for indexmap v2 r=jonasbb a=jonasbb

Introduces a new feature flag `indexmap_2` that enables the support.
Tests are copied from the v1 support.

Closes #621

Co-authored-by: Jonas Bushart <[email protected]>

Author: bors[bot]

.github/workflows/ci.yaml

@@ -61,7 +61,7 @@ jobs:
         # It is good to test more than the MSRV and stable since sometimes
         # breakage occurs in intermediate versions.
         # IMPORTANT: Synchronize the MSRV with the Cargo.toml values.
-        rust: ["1.61", "1.65", "1.70", "stable", "beta", "nightly"]
+        rust: ["1.64", "1.65", "1.70", "stable", "beta", "nightly"]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

Cargo.lock

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+* Add optional support for indexmap v2 (#621)
+    Support for v1 is already available using the `indexmap_1` feature.
+    This adds identical support for v2 of indexmap using the `indexmap_2` feature.
+
+### Changed
+
+* Bump MSRV to 1.64, since that is required for the indexmap v2 dependency.
+
 ## [3.1.0] - 2023-07-17
 
 ### Added

serde_with/CHANGELOG.md

@@ -5,7 +5,7 @@ authors = [
     "Marcin Kaźmierczak",
 ]
 name = "serde_with"
-rust-version = "1.61"
+rust-version = "1.64"
 version = "3.1.0"
 
 categories = ["encoding", "no-std", "no-std::no-alloc"]
@@ -43,6 +43,7 @@ std = [
     "chrono_0_4?/clock",
     "chrono_0_4?/std",
     "indexmap_1?/std",
+    "indexmap_2?/std",
     "time_0_3?/serde-well-known",
     "time_0_3?/std",
 ]
@@ -54,6 +55,7 @@ guide = ["dep:doc-comment", "macros", "std"]
 hex = ["dep:hex", "alloc"]
 indexmap = ["indexmap_1"]
 indexmap_1 = ["dep:indexmap_1", "alloc"]
+indexmap_2 = ["dep:indexmap_2", "alloc"]
 json = ["dep:serde_json", "alloc"]
 macros = ["dep:serde_with_macros"]
 time_0_3 = ["dep:time_0_3"]
@@ -65,6 +67,7 @@ chrono_0_4 = {package = "chrono", version = "0.4.20", optional = true, default-f
 doc-comment = {version = "0.3.3", optional = true}
 hex = {version = "0.4.3", optional = true, default-features = false}
 indexmap_1 = {package = "indexmap", version = "1.8", optional = true, default-features = false, features = ["serde-1"]}
+indexmap_2 = {package = "indexmap", version = "2.0", optional = true, default-features = false, features = ["serde"]}
 # The derive feature is needed for the flattened_maybe macro.
 # https://github.com/jonasbb/serde_with/blob/eb1965a74a3be073ecd13ec05f02a01bc1c44309/serde_with/src/flatten_maybe.rs#L67
 serde = {version = "1.0.157", default-features = false, features = ["derive"] }
@@ -113,6 +116,11 @@ name = "indexmap_1"
 path = "tests/indexmap_1.rs"
 required-features = ["indexmap_1", "macros"]
 
+[[test]]
+name = "indexmap_2"
+path = "tests/indexmap_2.rs"
+required-features = ["indexmap_2", "macros"]
+
 [[test]]
 name = "json"
 path = "tests/json.rs"

serde_with/Cargo.toml

@@ -9,6 +9,8 @@ use crate::{
 };
 #[cfg(feature = "indexmap_1")]
 use indexmap_1::{IndexMap, IndexSet};
+#[cfg(feature = "indexmap_2")]
+use indexmap_2::{IndexMap as IndexMap2, IndexSet as IndexSet2};
 
 struct SetPreventDuplicatesVisitor<SET, T, TAs>(PhantomData<(SET, T, TAs)>);
 

serde_with/src/de/duplicates.rs

@@ -1,6 +1,8 @@
 use crate::{formats::*, prelude::*};
 #[cfg(feature = "indexmap_1")]
 use indexmap_1::{IndexMap, IndexSet};
+#[cfg(feature = "indexmap_2")]
+use indexmap_2::{IndexMap as IndexMap2, IndexSet as IndexSet2};
 
 ///////////////////////////////////////////////////////////////////////////////
 // Helper macro used internally
@@ -16,6 +18,8 @@ macro_rules! foreach_map {
         $m!(HashMap<K: Eq + Hash, V, H: Sized>);
         #[cfg(all(feature = "std", feature = "indexmap_1"))]
         $m!(IndexMap<K: Eq + Hash, V, H: Sized>);
+        #[cfg(all(feature = "std", feature = "indexmap_2"))]
+        $m!(IndexMap2<K: Eq + Hash, V, H: Sized>);
     };
 }
 pub(crate) use foreach_map;
@@ -34,6 +38,11 @@ macro_rules! foreach_map_create {
             IndexMap<K: Eq + Hash, V, S: BuildHasher + Default>,
             (|size| IndexMap::with_capacity_and_hasher(size, Default::default()))
         );
+        #[cfg(feature = "indexmap_2")]
+        $m!(
+            IndexMap2<K: Eq + Hash, V, S: BuildHasher + Default>,
+            (|size| IndexMap2::with_capacity_and_hasher(size, Default::default()))
+        );
     };
 }
 pub(crate) use foreach_map_create;
@@ -46,6 +55,8 @@ macro_rules! foreach_set {
         $m!(HashSet<(K, V): Eq + Hash>);
         #[cfg(all(feature = "std", feature = "indexmap_1"))]
         $m!(IndexSet<(K, V): Eq + Hash>);
+        #[cfg(all(feature = "std", feature = "indexmap_2"))]
+        $m!(IndexSet2<(K, V): Eq + Hash>);
     }
 }
 pub(crate) use foreach_set;
@@ -66,6 +77,12 @@ macro_rules! foreach_set_create {
             (|size| IndexSet::with_capacity_and_hasher(size, S::default())),
             insert
         );
+        #[cfg(feature = "indexmap_2")]
+        $m!(
+            IndexSet2<T: Eq + Hash, S: BuildHasher + Default>,
+            (|size| IndexSet2::with_capacity_and_hasher(size, S::default())),
+            insert
+        );
     };
 }
 pub(crate) use foreach_set_create;

serde_with/src/de/impls.rs

@@ -1,6 +1,4 @@
 use crate::prelude::*;
-#[cfg(feature = "indexmap_1")]
-use indexmap_1::{IndexMap, IndexSet};
 
 pub trait PreventDuplicateInsertsSet<T> {
     fn new(size_hint: Option<usize>) -> Self;
@@ -37,7 +35,27 @@ where
 }
 
 #[cfg(feature = "indexmap_1")]
-impl<T, S> PreventDuplicateInsertsSet<T> for IndexSet<T, S>
+impl<T, S> PreventDuplicateInsertsSet<T> for indexmap_1::IndexSet<T, S>
+where
+    T: Eq + Hash,
+    S: BuildHasher + Default,
+{
+    #[inline]
+    fn new(size_hint: Option<usize>) -> Self {
+        match size_hint {
+            Some(size) => Self::with_capacity_and_hasher(size, S::default()),
+            None => Self::with_hasher(S::default()),
+        }
+    }
+
+    #[inline]
+    fn insert(&mut self, value: T) -> bool {
+        self.insert(value)
+    }
+}
+
+#[cfg(feature = "indexmap_2")]
+impl<T, S> PreventDuplicateInsertsSet<T> for indexmap_2::IndexSet<T, S>
 where
     T: Eq + Hash,
     S: BuildHasher + Default,
@@ -92,7 +110,27 @@ where
 }
 
 #[cfg(feature = "indexmap_1")]
-impl<K, V, S> PreventDuplicateInsertsMap<K, V> for IndexMap<K, V, S>
+impl<K, V, S> PreventDuplicateInsertsMap<K, V> for indexmap_1::IndexMap<K, V, S>
+where
+    K: Eq + Hash,
+    S: BuildHasher + Default,
+{
+    #[inline]
+    fn new(size_hint: Option<usize>) -> Self {
+        match size_hint {
+            Some(size) => Self::with_capacity_and_hasher(size, S::default()),
+            None => Self::with_hasher(S::default()),
+        }
+    }
+
+    #[inline]
+    fn insert(&mut self, key: K, value: V) -> bool {
+        self.insert(key, value).is_none()
+    }
+}
+
+#[cfg(feature = "indexmap_2")]
+impl<K, V, S> PreventDuplicateInsertsMap<K, V> for indexmap_2::IndexMap<K, V, S>
 where
     K: Eq + Hash,
     S: BuildHasher + Default,

serde_with/src/duplicate_key_impls/error_on_duplicate.rs

@@ -1,6 +1,4 @@
 use crate::prelude::*;
-#[cfg(feature = "indexmap_1")]
-use indexmap_1::IndexMap;
 
 pub trait DuplicateInsertsFirstWinsMap<K, V> {
     fn new(size_hint: Option<usize>) -> Self;
@@ -38,7 +36,7 @@ where
 }
 
 #[cfg(feature = "indexmap_1")]
-impl<K, V, S> DuplicateInsertsFirstWinsMap<K, V> for IndexMap<K, V, S>
+impl<K, V, S> DuplicateInsertsFirstWinsMap<K, V> for indexmap_1::IndexMap<K, V, S>
 where
     K: Eq + Hash,
     S: BuildHasher + Default,
@@ -65,6 +63,34 @@ where
     }
 }
 
+#[cfg(feature = "indexmap_2")]
+impl<K, V, S> DuplicateInsertsFirstWinsMap<K, V> for indexmap_2::IndexMap<K, V, S>
+where
+    K: Eq + Hash,
+    S: BuildHasher + Default,
+{
+    #[inline]
+    fn new(size_hint: Option<usize>) -> Self {
+        match size_hint {
+            Some(size) => Self::with_capacity_and_hasher(size, S::default()),
+            None => Self::with_hasher(S::default()),
+        }
+    }
+
+    #[inline]
+    fn insert(&mut self, key: K, value: V) {
+        use indexmap_2::map::Entry;
+
+        match self.entry(key) {
+            // we want to keep the first value, so do nothing
+            Entry::Occupied(_) => {}
+            Entry::Vacant(vacant) => {
+                vacant.insert(value);
+            }
+        }
+    }
+}
+
 impl<K, V> DuplicateInsertsFirstWinsMap<K, V> for BTreeMap<K, V>
 where
     K: Ord,

serde_with/src/duplicate_key_impls/first_value_wins.rs

@@ -1,6 +1,4 @@
 use crate::prelude::*;
-#[cfg(feature = "indexmap_1")]
-use indexmap_1::IndexSet;
 
 pub trait DuplicateInsertsLastWinsSet<T> {
     fn new(size_hint: Option<usize>) -> Self;
@@ -31,7 +29,28 @@ where
 }
 
 #[cfg(feature = "indexmap_1")]
-impl<T, S> DuplicateInsertsLastWinsSet<T> for IndexSet<T, S>
+impl<T, S> DuplicateInsertsLastWinsSet<T> for indexmap_1::IndexSet<T, S>
+where
+    T: Eq + Hash,
+    S: BuildHasher + Default,
+{
+    #[inline]
+    fn new(size_hint: Option<usize>) -> Self {
+        match size_hint {
+            Some(size) => Self::with_capacity_and_hasher(size, S::default()),
+            None => Self::with_hasher(S::default()),
+        }
+    }
+
+    #[inline]
+    fn replace(&mut self, value: T) {
+        // Hashset already fulfils the contract
+        self.replace(value);
+    }
+}
+
+#[cfg(feature = "indexmap_2")]
+impl<T, S> DuplicateInsertsLastWinsSet<T> for indexmap_2::IndexSet<T, S>
 where
     T: Eq + Hash,
     S: BuildHasher + Default,

serde_with/src/duplicate_key_impls/last_value_wins.rs

@@ -13,9 +13,10 @@ Using it in a `no_std` environment requires using `default-features = false`, si
 5. [`guide`](#guide)
 6. [`hex`](#hex)
 7. [`indexmap_1`](#indexmap_1)
-8. [`json`](#json)
-9. [`macros` (default)](#macros-default)
-10. [`time_0_3`](#time_0_3)
+8. [`indexmap_2`](#indexmap_2)
+9. [`json`](#json)
+10. [`macros` (default)](#macros-default)
+11. [`time_0_3`](#time_0_3)
 
 ## `alloc`
 
@@ -57,11 +58,20 @@ It enables the `alloc` feature.
 
 ## `indexmap_1`
 
-The `indexmap_1` feature enables implementations of `indexmap_1` specific checks.
+The `indexmap_1` feature enables implementations of `indexmap` v1 specific checks.
 This includes support for checking duplicate keys and duplicate values.
 The legacy feature name `indexmap` is still available for v1 compatability.
 
-This pulls in `indexmap` as a dependency.
+This pulls in `indexmap` v1 as a dependency.
+It enables the `alloc` feature.
+Some functionality is only available when `std` is enabled too.
+
+## `indexmap_2`
+
+The `indexmap_2` feature enables implementations of `indexmap` v2 specific checks.
+This includes support for checking duplicate keys and duplicate values.
+
+This pulls in `indexmap` v2 as a dependency.
 It enables the `alloc` feature.
 Some functionality is only available when `std` is enabled too.