Highlight feature-gated items in documentation

Author: rjsberry

Cargo.toml

@@ -53,7 +53,8 @@ no-dev-version = true
 tag-name = "{{version}}"
 
 [package.metadata.docs.rs]
-features = ["arbitrary", "quickcheck", "serde", "rayon"]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
 
 [workspace]
 members = ["test-nostd", "test-serde"]

src/lib.rs

@@ -76,6 +76,8 @@
 //!
 //! [def]: map/struct.IndexMap.html#impl-Default
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 extern crate alloc;
 
 #[cfg(feature = "std")]
@@ -92,6 +94,7 @@ mod mutable_keys;
 #[cfg(feature = "serde")]
 mod serde;
 #[cfg(feature = "serde")]
+#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 pub mod serde_seq;
 mod util;
 
@@ -245,4 +248,5 @@ impl core::fmt::Display for TryReserveError {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl std::error::Error for TryReserveError {}

src/macros.rs

@@ -1,4 +1,5 @@
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 #[macro_export]
 /// Create an `IndexMap` from a list of key-value pairs
 ///
@@ -35,6 +36,7 @@ macro_rules! indexmap {
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 #[macro_export]
 /// Create an `IndexSet` from a list of values
 ///

src/map.rs

@@ -148,6 +148,7 @@ where
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl<K, V> IndexMap<K, V> {
     /// Create a new map. (Does not allocate.)
     #[inline]
@@ -1112,6 +1113,8 @@ where
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+
 impl<K, V, const N: usize> From<[(K, V); N]> for IndexMap<K, V, RandomState>
 where
     K: Hash + Eq,

src/rayon/map.rs

@@ -2,8 +2,8 @@
 //!
 //! You will rarely need to interact with this module directly unless you need to name one of the
 //! iterator types.
-//!
-//! Requires crate feature `"rayon"`
+
+#![cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 
 use super::collect;
 use rayon::iter::plumbing::{Consumer, ProducerCallback, UnindexedConsumer};
@@ -21,7 +21,6 @@ use crate::Bucket;
 use crate::Entries;
 use crate::IndexMap;
 
-/// Requires crate feature `"rayon"`.
 impl<K, V, S> IntoParallelIterator for IndexMap<K, V, S>
 where
     K: Send,
@@ -37,7 +36,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<K, V> IntoParallelIterator for Box<Slice<K, V>>
 where
     K: Send,
@@ -81,7 +79,6 @@ impl<K: Send, V: Send> IndexedParallelIterator for IntoParIter<K, V> {
     indexed_parallel_iterator_methods!(Bucket::key_value);
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K, V, S> IntoParallelIterator for &'a IndexMap<K, V, S>
 where
     K: Sync,
@@ -97,7 +94,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K, V> IntoParallelIterator for &'a Slice<K, V>
 where
     K: Sync,
@@ -147,7 +143,6 @@ impl<K: Sync, V: Sync> IndexedParallelIterator for ParIter<'_, K, V> {
     indexed_parallel_iterator_methods!(Bucket::refs);
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K, V, S> IntoParallelIterator for &'a mut IndexMap<K, V, S>
 where
     K: Sync + Send,
@@ -163,7 +158,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K, V> IntoParallelIterator for &'a mut Slice<K, V>
 where
     K: Sync + Send,
@@ -207,7 +201,6 @@ impl<K: Sync + Send, V: Send> IndexedParallelIterator for ParIterMut<'_, K, V> {
     indexed_parallel_iterator_methods!(Bucket::ref_mut);
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K, V, S> ParallelDrainRange<usize> for &'a mut IndexMap<K, V, S>
 where
     K: Send,
@@ -395,7 +388,6 @@ impl<K: Sync, V: Sync> IndexedParallelIterator for ParValues<'_, K, V> {
     indexed_parallel_iterator_methods!(Bucket::value_ref);
 }
 
-/// Requires crate feature `"rayon"`.
 impl<K, V, S> IndexMap<K, V, S>
 where
     K: Send,
@@ -412,7 +404,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<K, V> Slice<K, V>
 where
     K: Send,
@@ -546,7 +537,6 @@ impl<K: Send, V: Send> IndexedParallelIterator for ParValuesMut<'_, K, V> {
     indexed_parallel_iterator_methods!(Bucket::value_mut);
 }
 
-/// Requires crate feature `"rayon"`.
 impl<K, V, S> FromParallelIterator<(K, V)> for IndexMap<K, V, S>
 where
     K: Eq + Hash + Send,
@@ -567,7 +557,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<K, V, S> ParallelExtend<(K, V)> for IndexMap<K, V, S>
 where
     K: Eq + Hash + Send,
@@ -584,7 +573,6 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
 impl<'a, K: 'a, V: 'a, S> ParallelExtend<(&'a K, &'a V)> for IndexMap<K, V, S>
 where
     K: Copy + Eq + Hash + Send + Sync,

src/rayon/set.rs

@@ -2,8 +2,8 @@
 //!
 //! You will rarely need to interact with this module directly unless you need to name one of the
 //! iterator types.
-//!
-//! Requires crate feature `"rayon"`.
+
+#![cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 
 use super::collect;
 use rayon::iter::plumbing::{Consumer, ProducerCallback, UnindexedConsumer};
@@ -22,7 +22,7 @@ use crate::IndexSet;
 
 type Bucket<T> = crate::Bucket<T, ()>;
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<T, S> IntoParallelIterator for IndexSet<T, S>
 where
     T: Send,
@@ -37,7 +37,7 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<T> IntoParallelIterator for Box<Slice<T>>
 where
     T: Send,
@@ -80,7 +80,7 @@ impl<T: Send> IndexedParallelIterator for IntoParIter<T> {
     indexed_parallel_iterator_methods!(Bucket::key);
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<'a, T, S> IntoParallelIterator for &'a IndexSet<T, S>
 where
     T: Sync,
@@ -95,7 +95,7 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<'a, T> IntoParallelIterator for &'a Slice<T>
 where
     T: Sync,
@@ -144,7 +144,7 @@ impl<T: Sync> IndexedParallelIterator for ParIter<'_, T> {
     indexed_parallel_iterator_methods!(Bucket::key_ref);
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<'a, T, S> ParallelDrainRange<usize> for &'a mut IndexSet<T, S>
 where
     T: Send,
@@ -585,7 +585,7 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<T, S> FromParallelIterator<T> for IndexSet<T, S>
 where
     T: Eq + Hash + Send,
@@ -605,7 +605,7 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<T, S> ParallelExtend<T> for IndexSet<T, S>
 where
     T: Eq + Hash + Send,
@@ -621,7 +621,7 @@ where
     }
 }
 
-/// Requires crate feature `"rayon"`.
+#[cfg_attr(docsrs, doc(cfg(feature = "rayon")))]
 impl<'a, T: 'a, S> ParallelExtend<&'a T> for IndexSet<T, S>
 where
     T: Copy + Eq + Hash + Send + Sync,

src/serde.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, doc(cfg(feature = "serde")))]
+
 use serde::de::value::{MapDeserializer, SeqDeserializer};
 use serde::de::{
     Deserialize, Deserializer, Error, IntoDeserializer, MapAccess, SeqAccess, Visitor,
@@ -10,7 +12,6 @@ use core::marker::PhantomData;
 
 use crate::IndexMap;
 
-/// Requires crate feature `"serde"`
 impl<K, V, S> Serialize for IndexMap<K, V, S>
 where
     K: Serialize + Hash + Eq,
@@ -54,7 +55,6 @@ where
     }
 }
 
-/// Requires crate feature `"serde"`
 impl<'de, K, V, S> Deserialize<'de> for IndexMap<K, V, S>
 where
     K: Deserialize<'de> + Eq + Hash,
@@ -85,7 +85,6 @@ where
 
 use crate::IndexSet;
 
-/// Requires crate feature `"serde"`
 impl<T, S> Serialize for IndexSet<T, S>
 where
     T: Serialize + Hash + Eq,
@@ -127,7 +126,6 @@ where
     }
 }
 
-/// Requires crate feature `"serde"`
 impl<'de, T, S> Deserialize<'de> for IndexSet<T, S>
 where
     T: Deserialize<'de> + Eq + Hash,

src/serde_seq.rs

@@ -17,8 +17,8 @@
 //!     // ...
 //! }
 //! ```
-//!
-//! Requires crate feature `"serde"`
+
+#![cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 
 use serde::de::{Deserialize, Deserializer, SeqAccess, Visitor};
 use serde::ser::{Serialize, Serializer};
@@ -35,8 +35,6 @@ use crate::IndexMap;
 ///
 /// This behaves like [`crate::serde_seq`] for `IndexMap`, serializing a sequence
 /// of `(key, value)` pairs, rather than as a map that might not preserve order.
-///
-/// Requires crate feature `"serde"`
 impl<K, V> Serialize for MapSlice<K, V>
 where
     K: Serialize,
@@ -51,8 +49,6 @@ where
 }
 
 /// Serializes a `set::Slice` as an ordered sequence.
-///
-/// Requires crate feature `"serde"`
 impl<T> Serialize for SetSlice<T>
 where
     T: Serialize,
@@ -79,8 +75,6 @@ where
 ///     // ...
 /// }
 /// ```
-///
-/// Requires crate feature `"serde"`
 pub fn serialize<K, V, S, T>(map: &IndexMap<K, V, S>, serializer: T) -> Result<T::Ok, T::Error>
 where
     K: Serialize + Hash + Eq,
@@ -135,8 +129,6 @@ where
 ///     // ...
 /// }
 /// ```
-///
-/// Requires crate feature `"serde"`
 pub fn deserialize<'de, D, K, V, S>(deserializer: D) -> Result<IndexMap<K, V, S>, D::Error>
 where
     D: Deserializer<'de>,

src/set.rs

@@ -135,6 +135,7 @@ where
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl<T> IndexSet<T> {
     /// Create a new set. (Does not allocate.)
     pub fn new() -> Self {
@@ -841,6 +842,7 @@ where
 }
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl<T, const N: usize> From<[T; N]> for IndexSet<T, RandomState>
 where
     T: Eq + Hash,