X-Git-Url: https://git.chrismorgan.info/anymap/blobdiff_plain/b549457d628fb178f6d700d85800f3ab63482d63..40e60cefd62236753888e887713692713683cdce:/src/lib.rs diff --git a/src/lib.rs b/src/lib.rs index d41c335..9c57f09 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,44 +1,152 @@ -//! This crate provides the `AnyMap` type, a safe and convenient store for one value of each type. +//! This crate provides a safe and convenient store for one value of each type. +//! +//! Your starting point is [`Map`]. It has an example. +//! +//! # Cargo features +//! +//! This crate has two independent features, each of which provides an implementation providing +//! types `Map`, `AnyMap`, `OccupiedEntry`, `VacantEntry`, `Entry` and `RawMap`: +//! +#![cfg_attr(feature = "std", doc = " - **std** (default, *enabled* in this build):")] +#![cfg_attr(not(feature = "std"), doc = " - **std** (default, *disabled* in this build):")] +//! an implementation using `std::collections::hash_map`, placed in the crate root +//! (e.g. `anymap::AnyMap`). +//! +#![cfg_attr(feature = "hashbrown", doc = " - **hashbrown** (optional; *enabled* in this build):")] +#![cfg_attr(not(feature = "hashbrown"), doc = " - **hashbrown** (optional; *disabled* in this build):")] +//! an implementation using `alloc` and `hashbrown::hash_map`, placed in a module `hashbrown` +//! (e.g. `anymap::hashbrown::AnyMap`). -#![cfg_attr(all(feature = "bench", test), feature(test))] #![warn(missing_docs, unused_results)] -#[cfg(all(feature = "bench", test))] -extern crate test; +#![cfg_attr(not(feature = "std"), no_std)] + +use core::convert::TryInto; +use core::hash::Hasher; + +#[cfg(not(feature = "std"))] +extern crate alloc; + +pub use crate::any::CloneAny; + +mod any; + +#[cfg(any(feature = "std", feature = "hashbrown"))] +macro_rules! everything { + ($example_init:literal, $($parent:ident)::+ $(, $entry_generics:ty)?) => { + use core::any::{Any, TypeId}; + use core::hash::BuildHasherDefault; + use core::marker::PhantomData; + + #[cfg(not(feature = "std"))] + use alloc::boxed::Box; + + use ::$($parent)::+::hash_map::{self, HashMap}; + + use crate::any::{Downcast, IntoBox}; + + /// Raw access to the underlying `HashMap`. + /// + /// This alias is provided for convenience because of the ugly third generic parameter. + pub type RawMap = HashMap, BuildHasherDefault>; + + /// A collection containing zero or one values for any given type and allowing convenient, + /// type-safe access to those values. + /// + /// The type parameter `A` allows you to use a different value type; normally you will want + /// it to be `core::any::Any` (also known as `std::any::Any`), but there are other choices: + /// + /// - If you want the entire map to be cloneable, use `CloneAny` instead of `Any`; with + /// that, you can only add types that implement `Clone` to the map. + /// - You can add on `+ Send` or `+ Send + Sync` (e.g. `Map`) to add those + /// auto traits. + /// + /// Cumulatively, there are thus six forms of map: + /// + /// - [Map]<dyn [core::any::Any]>, + /// also spelled [`AnyMap`] for convenience. + /// - [Map]<dyn [core::any::Any] + Send> + /// - [Map]<dyn [core::any::Any] + Send + Sync> + /// - [Map]<dyn [CloneAny]> + /// - [Map]<dyn [CloneAny] + Send> + /// - [Map]<dyn [CloneAny] + Send + Sync> + /// + /// ## Example + /// + /// (Here using the [`AnyMap`] convenience alias; the first line could use + /// [anymap::Map][Map]::<[core::any::Any]>::new() instead if desired.) + /// + /// ```rust + #[doc = $example_init] + /// assert_eq!(data.get(), None::<&i32>); + /// data.insert(42i32); + /// assert_eq!(data.get(), Some(&42i32)); + /// data.remove::(); + /// assert_eq!(data.get::(), None); + /// + /// #[derive(Clone, PartialEq, Debug)] + /// struct Foo { + /// str: String, + /// } + /// + /// assert_eq!(data.get::(), None); + /// data.insert(Foo { str: format!("foo") }); + /// assert_eq!(data.get(), Some(&Foo { str: format!("foo") })); + /// data.get_mut::().map(|foo| foo.str.push('t')); + /// assert_eq!(&*data.get::().unwrap().str, "foot"); + /// ``` + /// + /// Values containing non-static references are not permitted. + #[derive(Debug)] + pub struct Map { + raw: RawMap, + } -use std::any::TypeId; -use std::marker::PhantomData; + // #[derive(Clone)] would want A to implement Clone, but in reality only Box can. + impl Clone for Map where Box: Clone { + #[inline] + fn clone(&self) -> Map { + Map { + raw: self.raw.clone(), + } + } + } -use raw::RawMap; -use any::{UncheckedAnyExt, IntoBox, Any}; + /// The most common type of `Map`: just using `Any`; [Map]<dyn [Any]>. + /// + /// Why is this a separate type alias rather than a default value for `Map`? + /// `Map::new()` doesn’t seem to be happy to infer that it should go with the default + /// value. It’s a bit sad, really. Ah well, I guess this approach will do. + pub type AnyMap = Map; -macro_rules! impl_common_methods { - ( - field: $t:ident.$field:ident; - new() => $new:expr; - with_capacity($with_capacity_arg:ident) => $with_capacity:expr; - ) => { - impl $t { + impl Default for Map { + #[inline] + fn default() -> Map { + Map::new() + } + } + + impl Map { /// Create an empty collection. #[inline] - pub fn new() -> $t { - $t { - $field: $new, + pub fn new() -> Map { + Map { + raw: RawMap::with_hasher(Default::default()), } } /// Creates an empty collection with the given initial capacity. #[inline] - pub fn with_capacity($with_capacity_arg: usize) -> $t { - $t { - $field: $with_capacity, + pub fn with_capacity(capacity: usize) -> Map { + Map { + raw: RawMap::with_capacity_and_hasher(capacity, Default::default()), } } /// Returns the number of elements the collection can hold without reallocating. #[inline] pub fn capacity(&self) -> usize { - self.$field.capacity() + self.raw.capacity() } /// Reserves capacity for at least `additional` more elements to be inserted @@ -50,7 +158,7 @@ macro_rules! impl_common_methods { /// Panics if the new allocation size overflows `usize`. #[inline] pub fn reserve(&mut self, additional: usize) { - self.$field.reserve(additional) + self.raw.reserve(additional) } /// Shrinks the capacity of the collection as much as possible. It will drop @@ -58,468 +166,481 @@ macro_rules! impl_common_methods { /// and possibly leaving some space in accordance with the resize policy. #[inline] pub fn shrink_to_fit(&mut self) { - self.$field.shrink_to_fit() + self.raw.shrink_to_fit() } + // Additional stable methods (as of 1.60.0-nightly) that could be added: + // try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> (1.57.0) + // shrink_to(&mut self, min_capacity: usize) (1.56.0) + /// Returns the number of items in the collection. #[inline] pub fn len(&self) -> usize { - self.$field.len() + self.raw.len() } /// Returns true if there are no items in the collection. #[inline] pub fn is_empty(&self) -> bool { - self.$field.is_empty() + self.raw.is_empty() } /// Removes all items from the collection. Keeps the allocated memory for reuse. #[inline] pub fn clear(&mut self) { - self.$field.clear() + self.raw.clear() } - } - } -} - -pub mod any; -pub mod raw; - -/// A collection containing zero or one values for any given type and allowing convenient, -/// type-safe access to those values. -/// -/// The type parameter `A` allows you to use a different value type; normally you will want it to -/// be `anymap::any::Any`, but there are other choices: -/// -/// - If you want the entire map to be cloneable, use `CloneAny` instead of `Any`. -/// - You can add on `+ Send` and/or `+ Sync` (e.g. `Map`) to add those bounds. -/// -/// ```rust -/// # use anymap::AnyMap; -/// let mut data = AnyMap::new(); -/// assert_eq!(data.get(), None::<&i32>); -/// data.insert(42i32); -/// assert_eq!(data.get(), Some(&42i32)); -/// data.remove::(); -/// assert_eq!(data.get::(), None); -/// -/// #[derive(Clone, PartialEq, Debug)] -/// struct Foo { -/// str: String, -/// } -/// -/// assert_eq!(data.get::(), None); -/// data.insert(Foo { str: format!("foo") }); -/// assert_eq!(data.get(), Some(&Foo { str: format!("foo") })); -/// data.get_mut::().map(|foo| foo.str.push('t')); -/// assert_eq!(&*data.get::().unwrap().str, "foot"); -/// ``` -/// -/// Values containing non-static references are not permitted. -#[derive(Debug)] -pub struct Map { - raw: RawMap, -} -// #[derive(Clone)] would want A to implement Clone, but in reality it’s only Box that can. -impl Clone for Map where Box: Clone { - #[inline] - fn clone(&self) -> Map { - Map { - raw: self.raw.clone(), - } - } -} - -/// The most common type of `Map`: just using `Any`. -/// -/// Why is this a separate type alias rather than a default value for `Map`? `Map::new()` -/// doesn’t seem to be happy to infer that it should go with the default value. -/// It’s a bit sad, really. Ah well, I guess this approach will do. -pub type AnyMap = Map; - -impl_common_methods! { - field: Map.raw; - new() => RawMap::new(); - with_capacity(capacity) => RawMap::with_capacity(capacity); -} - -impl Map { - /// Returns a reference to the value stored in the collection for the type `T`, if it exists. - #[inline] - pub fn get>(&self) -> Option<&T> { - self.raw.get(&TypeId::of::()) - .map(|any| unsafe { any.downcast_ref_unchecked::() }) - } - - /// Returns a mutable reference to the value stored in the collection for the type `T`, - /// if it exists. - #[inline] - pub fn get_mut>(&mut self) -> Option<&mut T> { - self.raw.get_mut(&TypeId::of::()) - .map(|any| unsafe { any.downcast_mut_unchecked::() }) - } + /// Returns a reference to the value stored in the collection for the type `T`, + /// if it exists. + #[inline] + pub fn get>(&self) -> Option<&T> { + self.raw.get(&TypeId::of::()) + .map(|any| unsafe { any.downcast_ref_unchecked::() }) + } - /// Sets the value stored in the collection for the type `T`. - /// If the collection already had a value of type `T`, that value is returned. - /// Otherwise, `None` is returned. - #[inline] - pub fn insert>(&mut self, value: T) -> Option { - unsafe { - self.raw.insert(TypeId::of::(), value.into_box()) - .map(|any| *any.downcast_unchecked::()) - } - } + /// Returns a mutable reference to the value stored in the collection for the type `T`, + /// if it exists. + #[inline] + pub fn get_mut>(&mut self) -> Option<&mut T> { + self.raw.get_mut(&TypeId::of::()) + .map(|any| unsafe { any.downcast_mut_unchecked::() }) + } - /// Removes the `T` value from the collection, - /// returning it if there was one or `None` if there was not. - #[inline] - pub fn remove>(&mut self) -> Option { - self.raw.remove(&TypeId::of::()) - .map(|any| *unsafe { any.downcast_unchecked::() }) - } + /// Sets the value stored in the collection for the type `T`. + /// If the collection already had a value of type `T`, that value is returned. + /// Otherwise, `None` is returned. + #[inline] + pub fn insert>(&mut self, value: T) -> Option { + self.raw.insert(TypeId::of::(), value.into_box()) + .map(|any| unsafe { *any.downcast_unchecked::() }) + } - /// Returns true if the collection contains a value of type `T`. - #[inline] - pub fn contains>(&self) -> bool { - self.raw.contains_key(&TypeId::of::()) - } + // rustc 1.60.0-nightly has another method try_insert that would be nice when stable. - /// Gets the entry for the given type in the collection for in-place manipulation - #[inline] - pub fn entry>(&mut self) -> Entry { - match self.raw.entry(TypeId::of::()) { - raw::Entry::Occupied(e) => Entry::Occupied(OccupiedEntry { - inner: e, - type_: PhantomData, - }), - raw::Entry::Vacant(e) => Entry::Vacant(VacantEntry { - inner: e, - type_: PhantomData, - }), - } - } -} + /// Removes the `T` value from the collection, + /// returning it if there was one or `None` if there was not. + #[inline] + pub fn remove>(&mut self) -> Option { + self.raw.remove(&TypeId::of::()) + .map(|any| *unsafe { any.downcast_unchecked::() }) + } -impl AsRef> for Map { - #[inline] - fn as_ref(&self) -> &RawMap { - &self.raw - } -} + /// Returns true if the collection contains a value of type `T`. + #[inline] + pub fn contains>(&self) -> bool { + self.raw.contains_key(&TypeId::of::()) + } -impl AsMut> for Map { - #[inline] - fn as_mut(&mut self) -> &mut RawMap { - &mut self.raw - } -} + /// Gets the entry for the given type in the collection for in-place manipulation + #[inline] + pub fn entry>(&mut self) -> Entry { + match self.raw.entry(TypeId::of::()) { + hash_map::Entry::Occupied(e) => Entry::Occupied(OccupiedEntry { + inner: e, + type_: PhantomData, + }), + hash_map::Entry::Vacant(e) => Entry::Vacant(VacantEntry { + inner: e, + type_: PhantomData, + }), + } + } -impl Into> for Map { - #[inline] - fn into(self) -> RawMap { - self.raw - } -} + /// Get access to the raw hash map that backs this. + /// + /// This will seldom be useful, but it’s conceivable that you could wish to iterate + /// over all the items in the collection, and this lets you do that. + #[inline] + pub fn as_raw(&self) -> &RawMap { + &self.raw + } -/// A view into a single occupied location in an `Map`. -pub struct OccupiedEntry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { - inner: raw::OccupiedEntry<'a, A>, - type_: PhantomData, -} + /// Get mutable access to the raw hash map that backs this. + /// + /// This will seldom be useful, but it’s conceivable that you could wish to iterate + /// over all the items in the collection mutably, or drain or something, or *possibly* + /// even batch insert, and this lets you do that. + /// + /// # Safety + /// + /// If you insert any values to the raw map, the key (a `TypeId`) must match the + /// value’s type, or *undefined behaviour* will occur when you access those values. + /// + /// (*Removing* entries is perfectly safe.) + #[inline] + pub unsafe fn as_raw_mut(&mut self) -> &mut RawMap { + &mut self.raw + } -/// A view into a single empty location in an `Map`. -pub struct VacantEntry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { - inner: raw::VacantEntry<'a, A>, - type_: PhantomData, -} + /// Convert this into the raw hash map that backs this. + /// + /// This will seldom be useful, but it’s conceivable that you could wish to consume all + /// the items in the collection and do *something* with some or all of them, and this + /// lets you do that, without the `unsafe` that `.as_raw_mut().drain()` would require. + #[inline] + pub fn into_raw(self) -> RawMap { + self.raw + } -/// A view into a single location in an `Map`, which may be vacant or occupied. -pub enum Entry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { - /// An occupied Entry - Occupied(OccupiedEntry<'a, A, V>), - /// A vacant Entry - Vacant(VacantEntry<'a, A, V>), -} + /// Construct a map from a collection of raw values. + /// + /// You know what? I can’t immediately think of any legitimate use for this, especially + /// because of the requirement of the `BuildHasherDefault` generic in the + /// map. + /// + /// Perhaps this will be most practical as `unsafe { Map::from_raw(iter.collect()) }`, + /// `iter` being an iterator over `(TypeId, Box)` pairs. Eh, this method provides + /// symmetry with `into_raw`, so I don’t care if literally no one ever uses it. I’m not + /// even going to write a test for it, it’s so trivial. + /// + /// # Safety + /// + /// For all entries in the raw map, the key (a `TypeId`) must match the value’s type, + /// or *undefined behaviour* will occur when you access that entry. + #[inline] + pub unsafe fn from_raw(raw: RawMap) -> Map { + Self { raw } + } + } -impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> Entry<'a, A, V> { - /// Ensures a value is in the entry by inserting the default if empty, and returns - /// a mutable reference to the value in the entry. - #[inline] - pub fn or_insert(self, default: V) -> &'a mut V { - match self { - Entry::Occupied(inner) => inner.into_mut(), - Entry::Vacant(inner) => inner.insert(default), + impl Extend> for Map { + #[inline] + fn extend>>(&mut self, iter: T) { + for item in iter { + let _ = self.raw.insert(Downcast::type_id(&*item), item); + } + } } - } - /// Ensures a value is in the entry by inserting the result of the default function if empty, - /// and returns a mutable reference to the value in the entry. - #[inline] - pub fn or_insert_with V>(self, default: F) -> &'a mut V { - match self { - Entry::Occupied(inner) => inner.into_mut(), - Entry::Vacant(inner) => inner.insert(default()), + /// A view into a single occupied location in an `Map`. + pub struct OccupiedEntry<'a, A: ?Sized + Downcast, V: 'a> { + inner: hash_map::OccupiedEntry<'a, TypeId, Box, $($entry_generics)?>, + type_: PhantomData, } - } -} -impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> OccupiedEntry<'a, A, V> { - /// Gets a reference to the value in the entry - #[inline] - pub fn get(&self) -> &V { - unsafe { self.inner.get().downcast_ref_unchecked() } - } + /// A view into a single empty location in an `Map`. + pub struct VacantEntry<'a, A: ?Sized + Downcast, V: 'a> { + inner: hash_map::VacantEntry<'a, TypeId, Box, $($entry_generics)?>, + type_: PhantomData, + } - /// Gets a mutable reference to the value in the entry - #[inline] - pub fn get_mut(&mut self) -> &mut V { - unsafe { self.inner.get_mut().downcast_mut_unchecked() } - } + /// A view into a single location in an `Map`, which may be vacant or occupied. + pub enum Entry<'a, A: ?Sized + Downcast, V: 'a> { + /// An occupied Entry + Occupied(OccupiedEntry<'a, A, V>), + /// A vacant Entry + Vacant(VacantEntry<'a, A, V>), + } - /// Converts the OccupiedEntry into a mutable reference to the value in the entry - /// with a lifetime bound to the collection itself - #[inline] - pub fn into_mut(self) -> &'a mut V { - unsafe { self.inner.into_mut().downcast_mut_unchecked() } - } + impl<'a, A: ?Sized + Downcast, V: IntoBox> Entry<'a, A, V> { + /// Ensures a value is in the entry by inserting the default if empty, and returns + /// a mutable reference to the value in the entry. + #[inline] + pub fn or_insert(self, default: V) -> &'a mut V { + match self { + Entry::Occupied(inner) => inner.into_mut(), + Entry::Vacant(inner) => inner.insert(default), + } + } - /// Sets the value of the entry, and returns the entry's old value - #[inline] - pub fn insert(&mut self, value: V) -> V { - unsafe { *self.inner.insert(value.into_box()).downcast_unchecked() } - } + /// Ensures a value is in the entry by inserting the result of the default function if + /// empty, and returns a mutable reference to the value in the entry. + #[inline] + pub fn or_insert_with V>(self, default: F) -> &'a mut V { + match self { + Entry::Occupied(inner) => inner.into_mut(), + Entry::Vacant(inner) => inner.insert(default()), + } + } - /// Takes the value out of the entry, and returns it - #[inline] - pub fn remove(self) -> V { - unsafe { *self.inner.remove().downcast_unchecked() } - } -} + /// Ensures a value is in the entry by inserting the default value if empty, + /// and returns a mutable reference to the value in the entry. + #[inline] + pub fn or_default(self) -> &'a mut V where V: Default { + match self { + Entry::Occupied(inner) => inner.into_mut(), + Entry::Vacant(inner) => inner.insert(Default::default()), + } + } -impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> VacantEntry<'a, A, V> { - /// Sets the value of the entry with the VacantEntry's key, - /// and returns a mutable reference to it - #[inline] - pub fn insert(self, value: V) -> &'a mut V { - unsafe { self.inner.insert(value.into_box()).downcast_mut_unchecked() } - } -} + /// Provides in-place mutable access to an occupied entry before any potential inserts + /// into the map. + #[inline] + pub fn and_modify(self, f: F) -> Self { + match self { + Entry::Occupied(mut inner) => { + f(inner.get_mut()); + Entry::Occupied(inner) + }, + Entry::Vacant(inner) => Entry::Vacant(inner), + } + } -#[cfg(all(feature = "bench", test))] -mod bench { - use AnyMap; - use test::Bencher; - use test::black_box; + // Additional stable methods (as of 1.60.0-nightly) that could be added: + // insert_entry(self, value: V) -> OccupiedEntry<'a, K, V> (1.59.0) + } - #[bench] - fn insertion(b: &mut Bencher) { - b.iter(|| { - let mut data = AnyMap::new(); - for _ in 0..100 { - let _ = data.insert(42); + impl<'a, A: ?Sized + Downcast, V: IntoBox> OccupiedEntry<'a, A, V> { + /// Gets a reference to the value in the entry + #[inline] + pub fn get(&self) -> &V { + unsafe { self.inner.get().downcast_ref_unchecked() } } - }) - } - #[bench] - fn get_missing(b: &mut Bencher) { - b.iter(|| { - let data = AnyMap::new(); - for _ in 0..100 { - assert_eq!(data.get(), None::<&i32>); + /// Gets a mutable reference to the value in the entry + #[inline] + pub fn get_mut(&mut self) -> &mut V { + unsafe { self.inner.get_mut().downcast_mut_unchecked() } } - }) - } - #[bench] - fn get_present(b: &mut Bencher) { - b.iter(|| { - let mut data = AnyMap::new(); - let _ = data.insert(42); - // These inner loops are a feeble attempt to drown the other factors. - for _ in 0..100 { - assert_eq!(data.get(), Some(&42)); + /// Converts the OccupiedEntry into a mutable reference to the value in the entry + /// with a lifetime bound to the collection itself + #[inline] + pub fn into_mut(self) -> &'a mut V { + unsafe { self.inner.into_mut().downcast_mut_unchecked() } } - }) - } - macro_rules! big_benchmarks { - ($name:ident, $($T:ident)*) => ( - #[bench] - fn $name(b: &mut Bencher) { - $( - struct $T(&'static str); - )* - - b.iter(|| { - let mut data = AnyMap::new(); - $( - let _ = black_box(data.insert($T(stringify!($T)))); - )* - $( - let _ = black_box(data.get::<$T>()); - )* - }) - } - ); - } + /// Sets the value of the entry, and returns the entry's old value + #[inline] + pub fn insert(&mut self, value: V) -> V { + unsafe { *self.inner.insert(value.into_box()).downcast_unchecked() } + } - // Caution: if the macro does too much (e.g. assertions) this goes from being slow to being - // *really* slow (like add a minute for each assertion on it) and memory-hungry (like, adding - // several hundred megabytes to the peak for each assertion). - big_benchmarks! { - insert_and_get_on_260_types, - A0 B0 C0 D0 E0 F0 G0 H0 I0 J0 K0 L0 M0 N0 O0 P0 Q0 R0 S0 T0 U0 V0 W0 X0 Y0 Z0 - A1 B1 C1 D1 E1 F1 G1 H1 I1 J1 K1 L1 M1 N1 O1 P1 Q1 R1 S1 T1 U1 V1 W1 X1 Y1 Z1 - A2 B2 C2 D2 E2 F2 G2 H2 I2 J2 K2 L2 M2 N2 O2 P2 Q2 R2 S2 T2 U2 V2 W2 X2 Y2 Z2 - A3 B3 C3 D3 E3 F3 G3 H3 I3 J3 K3 L3 M3 N3 O3 P3 Q3 R3 S3 T3 U3 V3 W3 X3 Y3 Z3 - A4 B4 C4 D4 E4 F4 G4 H4 I4 J4 K4 L4 M4 N4 O4 P4 Q4 R4 S4 T4 U4 V4 W4 X4 Y4 Z4 - A5 B5 C5 D5 E5 F5 G5 H5 I5 J5 K5 L5 M5 N5 O5 P5 Q5 R5 S5 T5 U5 V5 W5 X5 Y5 Z5 - A6 B6 C6 D6 E6 F6 G6 H6 I6 J6 K6 L6 M6 N6 O6 P6 Q6 R6 S6 T6 U6 V6 W6 X6 Y6 Z6 - A7 B7 C7 D7 E7 F7 G7 H7 I7 J7 K7 L7 M7 N7 O7 P7 Q7 R7 S7 T7 U7 V7 W7 X7 Y7 Z7 - A8 B8 C8 D8 E8 F8 G8 H8 I8 J8 K8 L8 M8 N8 O8 P8 Q8 R8 S8 T8 U8 V8 W8 X8 Y8 Z8 - A9 B9 C9 D9 E9 F9 G9 H9 I9 J9 K9 L9 M9 N9 O9 P9 Q9 R9 S9 T9 U9 V9 W9 X9 Y9 Z9 - } + /// Takes the value out of the entry, and returns it + #[inline] + pub fn remove(self) -> V { + unsafe { *self.inner.remove().downcast_unchecked() } + } + } - big_benchmarks! { - insert_and_get_on_26_types, - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z - } -} + impl<'a, A: ?Sized + Downcast, V: IntoBox> VacantEntry<'a, A, V> { + /// Sets the value of the entry with the VacantEntry's key, + /// and returns a mutable reference to it + #[inline] + pub fn insert(self, value: V) -> &'a mut V { + unsafe { self.inner.insert(value.into_box()).downcast_mut_unchecked() } + } + } -#[cfg(test)] -mod tests { - use {Map, AnyMap, Entry}; - use any::{Any, CloneAny}; - - #[derive(Clone, Debug, PartialEq)] struct A(i32); - #[derive(Clone, Debug, PartialEq)] struct B(i32); - #[derive(Clone, Debug, PartialEq)] struct C(i32); - #[derive(Clone, Debug, PartialEq)] struct D(i32); - #[derive(Clone, Debug, PartialEq)] struct E(i32); - #[derive(Clone, Debug, PartialEq)] struct F(i32); - #[derive(Clone, Debug, PartialEq)] struct J(i32); - - macro_rules! test_entry { - ($name:ident, $init:ty) => { - #[test] - fn $name() { - let mut map = <$init>::new(); - assert_eq!(map.insert(A(10)), None); - assert_eq!(map.insert(B(20)), None); - assert_eq!(map.insert(C(30)), None); - assert_eq!(map.insert(D(40)), None); - assert_eq!(map.insert(E(50)), None); - assert_eq!(map.insert(F(60)), None); - - // Existing key (insert) - match map.entry::() { - Entry::Vacant(_) => unreachable!(), - Entry::Occupied(mut view) => { - assert_eq!(view.get(), &A(10)); - assert_eq!(view.insert(A(100)), A(10)); + #[cfg(test)] + mod tests { + use crate::CloneAny; + use super::*; + + #[derive(Clone, Debug, PartialEq)] struct A(i32); + #[derive(Clone, Debug, PartialEq)] struct B(i32); + #[derive(Clone, Debug, PartialEq)] struct C(i32); + #[derive(Clone, Debug, PartialEq)] struct D(i32); + #[derive(Clone, Debug, PartialEq)] struct E(i32); + #[derive(Clone, Debug, PartialEq)] struct F(i32); + #[derive(Clone, Debug, PartialEq)] struct J(i32); + + macro_rules! test_entry { + ($name:ident, $init:ty) => { + #[test] + fn $name() { + let mut map = <$init>::new(); + assert_eq!(map.insert(A(10)), None); + assert_eq!(map.insert(B(20)), None); + assert_eq!(map.insert(C(30)), None); + assert_eq!(map.insert(D(40)), None); + assert_eq!(map.insert(E(50)), None); + assert_eq!(map.insert(F(60)), None); + + // Existing key (insert) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(mut view) => { + assert_eq!(view.get(), &A(10)); + assert_eq!(view.insert(A(100)), A(10)); + } + } + assert_eq!(map.get::().unwrap(), &A(100)); + assert_eq!(map.len(), 6); + + + // Existing key (update) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(mut view) => { + let v = view.get_mut(); + let new_v = B(v.0 * 10); + *v = new_v; + } + } + assert_eq!(map.get::().unwrap(), &B(200)); + assert_eq!(map.len(), 6); + + + // Existing key (remove) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(view) => { + assert_eq!(view.remove(), C(30)); + } + } + assert_eq!(map.get::(), None); + assert_eq!(map.len(), 5); + + + // Inexistent key (insert) + match map.entry::() { + Entry::Occupied(_) => unreachable!(), + Entry::Vacant(view) => { + assert_eq!(*view.insert(J(1000)), J(1000)); + } + } + assert_eq!(map.get::().unwrap(), &J(1000)); + assert_eq!(map.len(), 6); + + // Entry.or_insert on existing key + map.entry::().or_insert(B(71)).0 += 1; + assert_eq!(map.get::().unwrap(), &B(201)); + assert_eq!(map.len(), 6); + + // Entry.or_insert on nonexisting key + map.entry::().or_insert(C(300)).0 += 1; + assert_eq!(map.get::().unwrap(), &C(301)); + assert_eq!(map.len(), 7); } } - assert_eq!(map.get::().unwrap(), &A(100)); - assert_eq!(map.len(), 6); + } + test_entry!(test_entry_any, AnyMap); + test_entry!(test_entry_cloneany, Map); - // Existing key (update) - match map.entry::() { - Entry::Vacant(_) => unreachable!(), - Entry::Occupied(mut view) => { - let v = view.get_mut(); - let new_v = B(v.0 * 10); - *v = new_v; - } - } - assert_eq!(map.get::().unwrap(), &B(200)); - assert_eq!(map.len(), 6); + #[test] + fn test_default() { + let map: AnyMap = Default::default(); + assert_eq!(map.len(), 0); + } + #[test] + fn test_clone() { + let mut map: Map = Map::new(); + let _ = map.insert(A(1)); + let _ = map.insert(B(2)); + let _ = map.insert(D(3)); + let _ = map.insert(E(4)); + let _ = map.insert(F(5)); + let _ = map.insert(J(6)); + let map2 = map.clone(); + assert_eq!(map2.len(), 6); + assert_eq!(map2.get::(), Some(&A(1))); + assert_eq!(map2.get::(), Some(&B(2))); + assert_eq!(map2.get::(), None); + assert_eq!(map2.get::(), Some(&D(3))); + assert_eq!(map2.get::(), Some(&E(4))); + assert_eq!(map2.get::(), Some(&F(5))); + assert_eq!(map2.get::(), Some(&J(6))); + } - // Existing key (remove) - match map.entry::() { - Entry::Vacant(_) => unreachable!(), - Entry::Occupied(view) => { - assert_eq!(view.remove(), C(30)); - } - } - assert_eq!(map.get::(), None); - assert_eq!(map.len(), 5); + #[test] + fn test_varieties() { + fn assert_send() { } + fn assert_sync() { } + fn assert_clone() { } + fn assert_debug() { } + assert_send::>(); + assert_send::>(); + assert_sync::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + assert_send::>(); + assert_send::>(); + assert_sync::>(); + assert_clone::>(); + assert_clone::>(); + assert_clone::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + } + #[test] + fn test_extend() { + let mut map = AnyMap::new(); + // (vec![] for 1.36.0 compatibility; more recently, you should use [] instead.) + #[cfg(not(feature = "std"))] + use alloc::vec; + map.extend(vec![Box::new(123) as Box, Box::new(456), Box::new(true)]); + assert_eq!(map.get(), Some(&456)); + assert_eq!(map.get::(), Some(&true)); + assert!(map.get::>().is_none()); + } + } + }; +} - // Inexistent key (insert) - match map.entry::() { - Entry::Occupied(_) => unreachable!(), - Entry::Vacant(view) => { - assert_eq!(*view.insert(J(1000)), J(1000)); - } - } - assert_eq!(map.get::().unwrap(), &J(1000)); - assert_eq!(map.len(), 6); +#[cfg(feature = "std")] +everything!( + "let mut data = anymap::AnyMap::new();", + std::collections +); - // Entry.or_insert on existing key - map.entry::().or_insert(B(71)).0 += 1; - assert_eq!(map.get::().unwrap(), &B(201)); - assert_eq!(map.len(), 6); +#[cfg(feature = "hashbrown")] +/// AnyMap backed by `hashbrown`. +/// +/// This depends on the `hashbrown` Cargo feature being enabled. +pub mod hashbrown { + use crate::TypeIdHasher; + #[cfg(doc)] + use crate::any::CloneAny; + + everything!( + "let mut data = anymap::hashbrown::AnyMap::new();", + hashbrown, + BuildHasherDefault + ); +} - // Entry.or_insert on nonexisting key - map.entry::().or_insert(C(300)).0 += 1; - assert_eq!(map.get::().unwrap(), &C(301)); - assert_eq!(map.len(), 7); - } - } - } +/// A hasher designed to eke a little more speed out, given `TypeId`’s known characteristics. +/// +/// Specifically, this is a no-op hasher that expects to be fed a u64’s worth of +/// randomly-distributed bits. It works well for `TypeId` (eliminating start-up time, so that my +/// get_missing benchmark is ~30ns rather than ~900ns, and being a good deal faster after that, so +/// that my insert_and_get_on_260_types benchmark is ~12μs instead of ~21.5μs), but will +/// panic in debug mode and always emit zeros in release mode for any other sorts of inputs, so +/// yeah, don’t use it! 😀 +#[derive(Default)] +pub struct TypeIdHasher { + value: u64, +} - test_entry!(test_entry_any, AnyMap); - test_entry!(test_entry_cloneany, Map); - - #[test] - fn test_clone() { - let mut map: Map = Map::new(); - let _ = map.insert(A(1)); - let _ = map.insert(B(2)); - let _ = map.insert(D(3)); - let _ = map.insert(E(4)); - let _ = map.insert(F(5)); - let _ = map.insert(J(6)); - let map2 = map.clone(); - assert_eq!(map2.len(), 6); - assert_eq!(map2.get::(), Some(&A(1))); - assert_eq!(map2.get::(), Some(&B(2))); - assert_eq!(map2.get::(), None); - assert_eq!(map2.get::(), Some(&D(3))); - assert_eq!(map2.get::(), Some(&E(4))); - assert_eq!(map2.get::(), Some(&F(5))); - assert_eq!(map2.get::(), Some(&J(6))); +impl Hasher for TypeIdHasher { + #[inline] + fn write(&mut self, bytes: &[u8]) { + // This expects to receive exactly one 64-bit value, and there’s no realistic chance of + // that changing, but I don’t want to depend on something that isn’t expressly part of the + // contract for safety. But I’m OK with release builds putting everything in one bucket + // if it *did* change (and debug builds panicking). + debug_assert_eq!(bytes.len(), 8); + let _ = bytes.try_into() + .map(|array| self.value = u64::from_ne_bytes(array)); } - #[test] - fn test_varieties() { - fn assert_send() { } - fn assert_sync() { } - fn assert_clone() { } - fn assert_debug() { } - assert_send::>(); - assert_send::>(); - assert_sync::>(); - assert_sync::>(); - assert_debug::>(); - assert_debug::>(); - assert_debug::>(); - assert_debug::>(); - assert_send::>(); - assert_send::>(); - assert_sync::>(); - assert_sync::>(); - assert_clone::>(); - assert_clone::>(); - assert_clone::>(); - assert_clone::>(); - assert_debug::>(); - assert_debug::>(); - assert_debug::>(); - assert_debug::>(); + #[inline] + fn finish(&self) -> u64 { self.value } +} + +#[test] +fn type_id_hasher() { + #[cfg(not(feature = "std"))] + use alloc::vec::Vec; + use core::hash::Hash; + use core::any::TypeId; + fn verify_hashing_with(type_id: TypeId) { + let mut hasher = TypeIdHasher::default(); + type_id.hash(&mut hasher); + // SAFETY: u64 is valid for all bit patterns. + assert_eq!(hasher.finish(), unsafe { core::mem::transmute::(type_id) }); } + // Pick a variety of types, just to demonstrate it’s all sane. Normal, zero-sized, unsized, &c. + verify_hashing_with(TypeId::of::()); + verify_hashing_with(TypeId::of::<()>()); + verify_hashing_with(TypeId::of::()); + verify_hashing_with(TypeId::of::<&str>()); + verify_hashing_with(TypeId::of::>()); }