/rust/registry/src/index.crates.io-6f17d22bba15001f/indexmap-2.5.0/src/lib.rs

Source (jump to first uncovered line)
// We *mostly* avoid unsafe code, but `map::core::raw` allows it to use `RawTable` buckets.
#![deny(unsafe_code)]
#![warn(rust_2018_idioms)]
#![no_std]

//! [`IndexMap`] is a hash table where the iteration order of the key-value
//! pairs is independent of the hash values of the keys.
//!
//! [`IndexSet`] is a corresponding hash set using the same implementation and
//! with similar properties.
//!
//! ### Highlights
//!
//! [`IndexMap`] and [`IndexSet`] are drop-in compatible with the std `HashMap`
//! and `HashSet`, but they also have some features of note:
//!
//! - The ordering semantics (see their documentation for details)
//! - Sorting methods and the [`.pop()`][IndexMap::pop] methods.
//! - The [`Equivalent`] trait, which offers more flexible equality definitions
//!   between borrowed and owned versions of keys.
//! - The [`MutableKeys`][map::MutableKeys] trait, which gives opt-in mutable
//!   access to map keys, and [`MutableValues`][set::MutableValues] for sets.
//!
//! ### Feature Flags
//!
//! To reduce the amount of compiled code in the crate by default, certain
//! features are gated behind [feature flags]. These allow you to opt in to (or
//! out of) functionality. Below is a list of the features available in this
//! crate.
//!
//! * `std`: Enables features which require the Rust standard library. For more
//!   information see the section on [`no_std`].
//! * `rayon`: Enables parallel iteration and other parallel methods.
//! * `serde`: Adds implementations for [`Serialize`] and [`Deserialize`]
//!   to [`IndexMap`] and [`IndexSet`]. Alternative implementations for
//!   (de)serializing [`IndexMap`] as an ordered sequence are available in the
//!   [`map::serde_seq`] module.
//! * `borsh`: Adds implementations for [`BorshSerialize`] and [`BorshDeserialize`]
//!   to [`IndexMap`] and [`IndexSet`].
//! * `arbitrary`: Adds implementations for the [`arbitrary::Arbitrary`] trait
//!   to [`IndexMap`] and [`IndexSet`].
//! * `quickcheck`: Adds implementations for the [`quickcheck::Arbitrary`] trait
//!   to [`IndexMap`] and [`IndexSet`].
//!
//! _Note: only the `std` feature is enabled by default._
//!
//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
//! [`no_std`]: #no-standard-library-targets
//! [`Serialize`]: `::serde::Serialize`
//! [`Deserialize`]: `::serde::Deserialize`
//! [`BorshSerialize`]: `::borsh::BorshSerialize`
//! [`BorshDeserialize`]: `::borsh::BorshDeserialize`
//! [`arbitrary::Arbitrary`]: `::arbitrary::Arbitrary`
//! [`quickcheck::Arbitrary`]: `::quickcheck::Arbitrary`
//!
//! ### Alternate Hashers
//!
//! [`IndexMap`] and [`IndexSet`] have a default hasher type
//! [`S = RandomState`][std::collections::hash_map::RandomState],
//! just like the standard `HashMap` and `HashSet`, which is resistant to
//! HashDoS attacks but not the most performant. Type aliases can make it easier
//! to use alternate hashers:
//!
//! ```
//! use fnv::FnvBuildHasher;
//! use fxhash::FxBuildHasher;
//! use indexmap::{IndexMap, IndexSet};
//!
//! type FnvIndexMap<K, V> = IndexMap<K, V, FnvBuildHasher>;
//! type FnvIndexSet<T> = IndexSet<T, FnvBuildHasher>;
//!
//! type FxIndexMap<K, V> = IndexMap<K, V, FxBuildHasher>;
//! type FxIndexSet<T> = IndexSet<T, FxBuildHasher>;
//!
//! let std: IndexSet<i32> = (0..100).collect();
//! let fnv: FnvIndexSet<i32> = (0..100).collect();
//! let fx: FxIndexSet<i32> = (0..100).collect();
//! assert_eq!(std, fnv);
//! assert_eq!(std, fx);
//! ```
//!
//! ### Rust Version
//!
//! This version of indexmap requires Rust 1.63 or later.
//!
//! The indexmap 2.x release series will use a carefully considered version
//! upgrade policy, where in a later 2.x version, we will raise the minimum
//! required Rust version.
//!
//! ## No Standard Library Targets
//!
//! This crate supports being built without `std`, requiring `alloc` instead.
//! This is chosen by disabling the default "std" cargo feature, by adding
//! `default-features = false` to your dependency specification.
//!
//! - Creating maps and sets using [`new`][IndexMap::new] and
//!   [`with_capacity`][IndexMap::with_capacity] is unavailable without `std`.
//!   Use methods [`IndexMap::default`], [`with_hasher`][IndexMap::with_hasher],
//!   [`with_capacity_and_hasher`][IndexMap::with_capacity_and_hasher] instead.
//!   A no-std compatible hasher will be needed as well, for example
//!   from the crate `twox-hash`.
//! - Macros [`indexmap!`] and [`indexset!`] are unavailable without `std`.

#![cfg_attr(docsrs, feature(doc_cfg))]

extern crate alloc;

#[cfg(feature = "std")]
#[macro_use]
extern crate std;

use alloc::vec::{self, Vec};

mod arbitrary;
#[macro_use]
mod macros;
#[cfg(feature = "borsh")]
mod borsh;
#[cfg(feature = "serde")]
mod serde;
mod util;

pub mod map;
pub mod set;

// Placed after `map` and `set` so new `rayon` methods on the types
// are documented after the "normal" methods.
#[cfg(feature = "rayon")]
mod rayon;

#[cfg(feature = "rustc-rayon")]
mod rustc;

pub use crate::map::IndexMap;
pub use crate::set::IndexSet;
pub use equivalent::Equivalent;

// shared private items

/// Hash value newtype. Not larger than usize, since anything larger
/// isn't used for selecting position anyway.
#[derive(Clone, Copy, Debug, PartialEq)]
struct HashValue(usize);

impl HashValue {
    #[inline(always)]
    fn get(self) -> u64 {
        self.0 as u64
    }
}

#[derive(Copy, Debug)]
struct Bucket<K, V> {
    hash: HashValue,
    key: K,
    value: V,
}

impl<K, V> Clone for Bucket<K, V>
where
    K: Clone,
    V: Clone,
{
    fn clone(&self) -> Self {
        Bucket {
            hash: self.hash,
            key: self.key.clone(),
            value: self.value.clone(),
        }
    }

    fn clone_from(&mut self, other: &Self) {
        self.hash = other.hash;
        self.key.clone_from(&other.key);
        self.value.clone_from(&other.value);
    }
}

impl<K, V> Bucket<K, V> {
    // field accessors -- used for `f` instead of closures in `.map(f)`
    fn key_ref(&self) -> &K {
        &self.key
    }
    fn value_ref(&self) -> &V {
        &self.value
    }
    fn value_mut(&mut self) -> &mut V {
        &mut self.value
    }
    fn key(self) -> K {
        self.key
    }
    fn value(self) -> V {
        self.value
    }
    fn key_value(self) -> (K, V) {
        (self.key, self.value)
    }
    fn refs(&self) -> (&K, &V) {
        (&self.key, &self.value)
    }
    fn ref_mut(&mut self) -> (&K, &mut V) {
        (&self.key, &mut self.value)
    }
    fn muts(&mut self) -> (&mut K, &mut V) {
        (&mut self.key, &mut self.value)
    }
}

trait Entries {
    type Entry;
    fn into_entries(self) -> Vec<Self::Entry>;
    fn as_entries(&self) -> &[Self::Entry];
    fn as_entries_mut(&mut self) -> &mut [Self::Entry];
    fn with_entries<F>(&mut self, f: F)
    where
        F: FnOnce(&mut [Self::Entry]);
}

/// The error type for [`try_reserve`][IndexMap::try_reserve] methods.
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct TryReserveError {
    kind: TryReserveErrorKind,
}

#[derive(Clone, PartialEq, Eq, Debug)]
enum TryReserveErrorKind {
    // The standard library's kind is currently opaque to us, otherwise we could unify this.
    Std(alloc::collections::TryReserveError),
    CapacityOverflow,
    AllocError { layout: alloc::alloc::Layout },
}

// These are not `From` so we don't expose them in our public API.
impl TryReserveError {
    fn from_alloc(error: alloc::collections::TryReserveError) -> Self {
        Self {
            kind: TryReserveErrorKind::Std(error),
        }
    }

    fn from_hashbrown(error: hashbrown::TryReserveError) -> Self {
        Self {
            kind: match error {
                hashbrown::TryReserveError::CapacityOverflow => {
                    TryReserveErrorKind::CapacityOverflow
                }
                hashbrown::TryReserveError::AllocError { layout } => {
                    TryReserveErrorKind::AllocError { layout }
                }
            },
        }
    }
}

impl core::fmt::Display for TryReserveError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let reason = match &self.kind {
            TryReserveErrorKind::Std(e) => return core::fmt::Display::fmt(e, f),
            TryReserveErrorKind::CapacityOverflow => {
                " because the computed capacity exceeded the collection's maximum"
            }
            TryReserveErrorKind::AllocError { .. } => {
                " because the memory allocator returned an error"
            }
        };
        f.write_str("memory allocation failed")?;
        f.write_str(reason)
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for TryReserveError {}

Coverage Report

Created: 2025-06-24 06:17

Line	Count	Source (jump to first uncovered line)
1		// We mostly avoid unsafe code, but `map::core::raw` allows it to use `RawTable` buckets.
2		#![deny(unsafe_code)]
3		#![warn(rust_2018_idioms)]
4		#![no_std]
5
6		//! [`IndexMap`] is a hash table where the iteration order of the key-value
7		//! pairs is independent of the hash values of the keys.
8		//!
9		//! [`IndexSet`] is a corresponding hash set using the same implementation and
10		//! with similar properties.
11		//!
12		//! ### Highlights
13		//!
14		//! [`IndexMap`] and [`IndexSet`] are drop-in compatible with the std `HashMap`
15		//! and `HashSet`, but they also have some features of note:
16		//!
17		//! - The ordering semantics (see their documentation for details)
18		//! - Sorting methods and the [`.pop()`][IndexMap::pop] methods.
19		//! - The [`Equivalent`] trait, which offers more flexible equality definitions
20		//! between borrowed and owned versions of keys.
21		//! - The [`MutableKeys`][map::MutableKeys] trait, which gives opt-in mutable
22		//! access to map keys, and [`MutableValues`][set::MutableValues] for sets.
23		//!
24		//! ### Feature Flags
25		//!
26		//! To reduce the amount of compiled code in the crate by default, certain
27		//! features are gated behind [feature flags]. These allow you to opt in to (or
28		//! out of) functionality. Below is a list of the features available in this
29		//! crate.
30		//!
31		//! * `std`: Enables features which require the Rust standard library. For more
32		//! information see the section on [`no_std`].
33		//! * `rayon`: Enables parallel iteration and other parallel methods.
34		//! * `serde`: Adds implementations for [`Serialize`] and [`Deserialize`]
35		//! to [`IndexMap`] and [`IndexSet`]. Alternative implementations for
36		//! (de)serializing [`IndexMap`] as an ordered sequence are available in the
37		//! [`map::serde_seq`] module.
38		//! * `borsh`: Adds implementations for [`BorshSerialize`] and [`BorshDeserialize`]
39		//! to [`IndexMap`] and [`IndexSet`].
40		//! * `arbitrary`: Adds implementations for the [`arbitrary::Arbitrary`] trait
41		//! to [`IndexMap`] and [`IndexSet`].
42		//! * `quickcheck`: Adds implementations for the [`quickcheck::Arbitrary`] trait
43		//! to [`IndexMap`] and [`IndexSet`].
44		//!
45		//! _Note: only the `std` feature is enabled by default._
46		//!
47		//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
48		//! [`no_std`]: #no-standard-library-targets
49		//! [`Serialize`]: `::serde::Serialize`
50		//! [`Deserialize`]: `::serde::Deserialize`
51		//! [`BorshSerialize`]: `::borsh::BorshSerialize`
52		//! [`BorshDeserialize`]: `::borsh::BorshDeserialize`
53		//! [`arbitrary::Arbitrary`]: `::arbitrary::Arbitrary`
54		//! [`quickcheck::Arbitrary`]: `::quickcheck::Arbitrary`
55		//!
56		//! ### Alternate Hashers
57		//!
58		//! [`IndexMap`] and [`IndexSet`] have a default hasher type
59		//! [`S = RandomState`][std::collections::hash_map::RandomState],
60		//! just like the standard `HashMap` and `HashSet`, which is resistant to
61		//! HashDoS attacks but not the most performant. Type aliases can make it easier
62		//! to use alternate hashers:
63		//!
64		//! ```
65		//! use fnv::FnvBuildHasher;
66		//! use fxhash::FxBuildHasher;
67		//! use indexmap::{IndexMap, IndexSet};
68		//!
69		//! type FnvIndexMap<K, V> = IndexMap<K, V, FnvBuildHasher>;
70		//! type FnvIndexSet<T> = IndexSet<T, FnvBuildHasher>;
71		//!
72		//! type FxIndexMap<K, V> = IndexMap<K, V, FxBuildHasher>;
73		//! type FxIndexSet<T> = IndexSet<T, FxBuildHasher>;
74		//!
75		//! let std: IndexSet<i32> = (0..100).collect();
76		//! let fnv: FnvIndexSet<i32> = (0..100).collect();
77		//! let fx: FxIndexSet<i32> = (0..100).collect();
78		//! assert_eq!(std, fnv);
79		//! assert_eq!(std, fx);
80		//! ```
81		//!
82		//! ### Rust Version
83		//!
84		//! This version of indexmap requires Rust 1.63 or later.
85		//!
86		//! The indexmap 2.x release series will use a carefully considered version
87		//! upgrade policy, where in a later 2.x version, we will raise the minimum
88		//! required Rust version.
89		//!
90		//! ## No Standard Library Targets
91		//!
92		//! This crate supports being built without `std`, requiring `alloc` instead.
93		//! This is chosen by disabling the default "std" cargo feature, by adding
94		//! `default-features = false` to your dependency specification.
95		//!
96		//! - Creating maps and sets using [`new`][IndexMap::new] and
97		//! [`with_capacity`][IndexMap::with_capacity] is unavailable without `std`.
98		//! Use methods [`IndexMap::default`], [`with_hasher`][IndexMap::with_hasher],
99		//! [`with_capacity_and_hasher`][IndexMap::with_capacity_and_hasher] instead.
100		//! A no-std compatible hasher will be needed as well, for example
101		//! from the crate `twox-hash`.
102		//! - Macros [`indexmap!`] and [`indexset!`] are unavailable without `std`.
103
104		#![cfg_attr(docsrs, feature(doc_cfg))]
105
106		extern crate alloc;
107
108		#[cfg(feature = "std")]
109		#[macro_use]
110		extern crate std;
111
112		use alloc::vec::{self, Vec};
113
114		mod arbitrary;
115		#[macro_use]
116		mod macros;
117		#[cfg(feature = "borsh")]
118		mod borsh;
119		#[cfg(feature = "serde")]
120		mod serde;
121		mod util;
122
123		pub mod map;
124		pub mod set;
125
126		// Placed after `map` and `set` so new `rayon` methods on the types
127		// are documented after the "normal" methods.
128		#[cfg(feature = "rayon")]
129		mod rayon;
130
131		#[cfg(feature = "rustc-rayon")]
132		mod rustc;
133
134		pub use crate::map::IndexMap;
135		pub use crate::set::IndexSet;
136		pub use equivalent::Equivalent;
137
138		// shared private items
139
140		/// Hash value newtype. Not larger than usize, since anything larger
141		/// isn't used for selecting position anyway.
142		#[derive(Clone, Copy, Debug, PartialEq)]
143		struct HashValue(usize);
144
145		impl HashValue {
146		#[inline(always)]
147	0	fn get(self) -> u64 {
148	0	self.0 as u64
149	0	}
150		}
151
152		#[derive(Copy, Debug)]
153		struct Bucket<K, V> {
154		hash: HashValue,
155		key: K,
156		value: V,
157		}
158
159		impl<K, V> Clone for Bucket<K, V>
160		where
161		K: Clone,
162		V: Clone,
163		{
164	0	fn clone(&self) -> Self {
165	0	Bucket {
166	0	hash: self.hash,
167	0	key: self.key.clone(),
168	0	value: self.value.clone(),
169	0	}
170	0	} Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, indexmap::map::IndexMap<alloc::string::String, core::option::Option<alloc::string::String>>> as core::clone::Clone>::clone Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, core::option::Option<alloc::string::String>> as core::clone::Clone>::clone Unexecuted instantiation: <indexmap::Bucket<_, _> as core::clone::Clone>::clone
171
172	0	fn clone_from(&mut self, other: &Self) {
173	0	self.hash = other.hash;
174	0	self.key.clone_from(&other.key);
175	0	self.value.clone_from(&other.value);
176	0	} Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, indexmap::map::IndexMap<alloc::string::String, core::option::Option<alloc::string::String>>> as core::clone::Clone>::clone_from Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, core::option::Option<alloc::string::String>> as core::clone::Clone>::clone_from Unexecuted instantiation: <indexmap::Bucket<_, _> as core::clone::Clone>::clone_from
177		}
178
179		impl<K, V> Bucket<K, V> {
180		// field accessors -- used for `f` instead of closures in `.map(f)`
181	0	fn key_ref(&self) -> &K {
182	0	&self.key
183	0	} Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, indexmap::map::IndexMap<alloc::string::String, core::option::Option<alloc::string::String>>>>::key_ref Unexecuted instantiation: <indexmap::Bucket<_, _>>::key_ref
184	0	fn value_ref(&self) -> &V {
185	0	&self.value
186	0	}
187	0	fn value_mut(&mut self) -> &mut V {
188	0	&mut self.value
189	0	}
190	0	fn key(self) -> K {
191	0	self.key
192	0	}
193	0	fn value(self) -> V {
194	0	self.value
195	0	}
196	0	fn key_value(self) -> (K, V) {
197	0	(self.key, self.value)
198	0	} Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, core::option::Option<alloc::string::String>>>::key_value Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, indexmap::map::IndexMap<alloc::string::String, core::option::Option<alloc::string::String>>>>::key_value Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, core::option::Option<alloc::string::String>>>::key_value Unexecuted instantiation: <indexmap::Bucket<_, _>>::key_value
199	0	fn refs(&self) -> (&K, &V) {
200	0	(&self.key, &self.value)
201	0	} Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, indexmap::map::IndexMap<alloc::string::String, core::option::Option<alloc::string::String>>>>::refs Unexecuted instantiation: <indexmap::Bucket<alloc::string::String, core::option::Option<alloc::string::String>>>::refs Unexecuted instantiation: <indexmap::Bucket<cras_ini::utf8cstring::Utf8CString, cras_ini::utf8cstring::Utf8CString>>::refs Unexecuted instantiation: <indexmap::Bucket<cras_ini::utf8cstring::Utf8CString, indexmap::map::IndexMap<cras_ini::utf8cstring::Utf8CString, cras_ini::utf8cstring::Utf8CString>>>::refs Unexecuted instantiation: <indexmap::Bucket<cras_ini::utf8cstring::Utf8CString, cras_ini::utf8cstring::Utf8CString>>::refs Unexecuted instantiation: <indexmap::Bucket<_, _>>::refs
202	0	fn ref_mut(&mut self) -> (&K, &mut V) {
203	0	(&self.key, &mut self.value)
204	0	}
205	0	fn muts(&mut self) -> (&mut K, &mut V) {
206	0	(&mut self.key, &mut self.value)
207	0	}
208		}
209
210		trait Entries {
211		type Entry;
212		fn into_entries(self) -> Vec<Self::Entry>;
213		fn as_entries(&self) -> &[Self::Entry];
214		fn as_entries_mut(&mut self) -> &mut [Self::Entry];
215		fn with_entries<F>(&mut self, f: F)
216		where
217		F: FnOnce(&mut [Self::Entry]);
218		}
219
220		/// The error type for [`try_reserve`][IndexMap::try_reserve] methods.
221		#[derive(Clone, PartialEq, Eq, Debug)]
222		pub struct TryReserveError {
223		kind: TryReserveErrorKind,
224		}
225
226		#[derive(Clone, PartialEq, Eq, Debug)]
227		enum TryReserveErrorKind {
228		// The standard library's kind is currently opaque to us, otherwise we could unify this.
229		Std(alloc::collections::TryReserveError),
230		CapacityOverflow,
231		AllocError { layout: alloc::alloc::Layout },
232		}
233
234		// These are not `From` so we don't expose them in our public API.
235		impl TryReserveError {
236	0	fn from_alloc(error: alloc::collections::TryReserveError) -> Self {
237	0	Self {
238	0	kind: TryReserveErrorKind::Std(error),
239	0	}
240	0	}
241
242	0	fn from_hashbrown(error: hashbrown::TryReserveError) -> Self {
243	0	Self {
244	0	kind: match error {
245		hashbrown::TryReserveError::CapacityOverflow => {
246	0	TryReserveErrorKind::CapacityOverflow
247		}
248	0	hashbrown::TryReserveError::AllocError { layout } => {
249	0	TryReserveErrorKind::AllocError { layout }
250		}
251		},
252		}
253	0	}
254		}
255
256		impl core::fmt::Display for TryReserveError {
257	0	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
258	0	let reason = match &self.kind {
259	0	TryReserveErrorKind::Std(e) => return core::fmt::Display::fmt(e, f),
260		TryReserveErrorKind::CapacityOverflow => {
261	0	" because the computed capacity exceeded the collection's maximum"
262		}
263		TryReserveErrorKind::AllocError { .. } => {
264	0	" because the memory allocator returned an error"
265		}
266		};
267	0	f.write_str("memory allocation failed")?;
268	0	f.write_str(reason)
269	0	}
270		}
271
272		#[cfg(feature = "std")]
273		#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
274		impl std::error::Error for TryReserveError {}