Convert seq to map using Map instead of the older BTreeMap/HashMap

jonasbb · Mar 7, 2023 · fa2fab7 · fa2fab7
1 parent d49ca22
commit fa2fab7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -142,7 +142,7 @@ enum Foo {
         // We can treat a Vec like a map with duplicates.
         // JSON only allows string keys, so convert i32 to strings
         // The bytes will be hex encoded
-        #[serde_as(as = "BTreeMap<DisplayFromStr, Hex>")]
+        #[serde_as(as = "Map<DisplayFromStr, Hex>")]
         bytes: Vec<(i32, Vec<u8>)>,
     }
 }

diff --git a/serde_with/src/guide.md b/serde_with/src/guide.md
@@ -21,8 +21,7 @@ The `serde_as` scheme is based on two new traits: [`SerializeAs`] and [`Deserial
 
 ```rust
 # use serde::{Deserialize, Serialize};
-# use serde_with::{serde_as, DisplayFromStr};
-# use std::collections::HashMap;
+# use serde_with::{serde_as, DisplayFromStr, Map};
 # use std::net::Ipv4Addr;
 #
 #[serde_as]
@@ -34,7 +33,7 @@ struct Data {
     address: Ipv4Addr,
     // Treat the Vec like a map with duplicates
     // Convert u32 into a String and keep the String the same type
-    #[serde_as(as = "HashMap<DisplayFromStr, _>")]
+    #[serde_as(as = "Map<DisplayFromStr, _>")]
     vec_as_map: Vec<(u32, String)>,
 }
 

diff --git a/serde_with/src/lib.rs b/serde_with/src/lib.rs
@@ -210,9 +210,8 @@
 //! # #[cfg(all(feature = "macros", feature = "hex"))]
 //! # use {
 //! #     serde::{Deserialize, Serialize},
-//! #     serde_with::{serde_as, DisplayFromStr, DurationSeconds, hex::Hex},
+//! #     serde_with::{serde_as, DisplayFromStr, DurationSeconds, hex::Hex, Map},
 //! #     std::time::Duration,
-//! #     std::collections::BTreeMap,
 //! # };
 //! # #[cfg(all(feature = "macros", feature = "hex"))]
 //! #[serde_as]
@@ -228,7 +227,7 @@
 //!         // We can treat a Vec like a map with duplicates.
 //!         // JSON only allows string keys, so convert i32 to strings
 //!         // The bytes will be hex encoded
-//!         #[serde_as(as = "BTreeMap<DisplayFromStr, Hex>")]
+//!         #[serde_as(as = "Map<DisplayFromStr, Hex>")]
 //!         bytes: Vec<(i32, Vec<u8>)>,
 //!     }
 //! }

diff --git a/serde_with_macros/src/lib.rs b/serde_with_macros/src/lib.rs
@@ -461,8 +461,7 @@ fn field_has_attribute(field: &Field, namespace: &str, name: &str) -> bool {
 /// # Example
 ///
 /// ```rust,ignore
-/// use serde_with::{serde_as, DisplayFromStr};
-/// use std::collections::HashMap;
+/// use serde_with::{serde_as, DisplayFromStr, Map};
 ///
 /// #[serde_as]
 /// #[derive(Serialize, Deserialize)]
@@ -476,7 +475,7 @@ fn field_has_attribute(field: &Field, namespace: &str, name: &str) -> bool {
 ///     b: u32,
 ///
 ///     /// Serialize into a map from String to String
-///     #[serde_as(as = "HashMap<DisplayFromStr, _>")]
+///     #[serde_as(as = "Map<DisplayFromStr, _>")]
 ///     c: Vec<(u32, String)>,
 /// }
 /// ```