-//! 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.
-#![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 std::any::TypeId;
-use std::marker::PhantomData;
+use core::any::{Any, TypeId};
+use core::marker::PhantomData;
+
+#[cfg(not(any(feature = "std", feature = "hashbrown")))]
+compile_error!("anymap: you must enable the 'std' feature or the 'hashbrown' feature");
+
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+
+#[cfg(not(feature = "std"))]
+use alloc::boxed::Box;
use raw::RawMap;
-use any::{UncheckedAnyExt, IntoBox, Any};
+use any::{UncheckedAnyExt, IntoBox};
+pub use any::CloneAny;
macro_rules! impl_common_methods {
(
self.$field.clear()
}
}
+
+ impl<A: ?Sized + UncheckedAnyExt> Default for $t<A> {
+ #[inline]
+ fn default() -> $t<A> {
+ $t::new()
+ }
+ }
}
}
-pub mod any;
+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:
+/// 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<dyn Any + Send>`) to add those auto
+/// traits.
///
-/// - 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<Any + Send>`) to add those bounds.
+/// Cumulatively, there are thus six forms of map:
+///
+/// - <code>[Map]<dyn [core::any::Any]></code>, also spelled [`AnyMap`] for convenience.
+/// - <code>[Map]<dyn [core::any::Any] + Send></code>
+/// - <code>[Map]<dyn [core::any::Any] + Send + Sync></code>
+/// - <code>[Map]<dyn [CloneAny]></code>
+/// - <code>[Map]<dyn [CloneAny] + Send></code>
+/// - <code>[Map]<dyn [CloneAny] + Send + Sync></code>
+///
+/// ## Example
+///
+/// (Here using the [`AnyMap`] convenience alias; the first line could use
+/// <code>[anymap::Map][Map]::<[core::any::Any]>::new()</code> instead if desired.)
///
/// ```rust
-/// # use anymap::AnyMap;
-/// let mut data = AnyMap::new();
+/// let mut data = anymap::AnyMap::new();
/// assert_eq!(data.get(), None::<&i32>);
/// data.insert(42i32);
/// assert_eq!(data.get(), Some(&42i32));
///
/// Values containing non-static references are not permitted.
#[derive(Debug)]
-pub struct Map<A: ?Sized + UncheckedAnyExt = Any> {
+pub struct Map<A: ?Sized + UncheckedAnyExt = dyn Any> {
raw: RawMap<A>,
}
}
}
-/// The most common type of `Map`: just using `Any`.
+/// The most common type of `Map`: just using `Any`; <code>[Map]<dyn [Any]></code>.
///
/// Why is this a separate type alias rather than a default value for `Map<A>`? `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<Any>;
+pub type AnyMap = Map<dyn Any>;
impl_common_methods! {
field: Map.raw;
}
}
-impl<A: ?Sized + UncheckedAnyExt>
Into<RawMap<A>> for Map<A> {
+impl<A: ?Sized + UncheckedAnyExt>
From<Map<A>> for RawMap<A> {
#[inline]
- fn
into(self) -> RawMap<A> {
- self.raw
+ fn
from(map: Map<A>) -> RawMap<A> {
+ map.raw
}
}
}
}
-#[cfg(all(feature = "bench", test))]
-mod bench {
- use AnyMap;
- use test::Bencher;
- use test::black_box;
-
- #[bench]
- fn insertion(b: &mut Bencher) {
- b.iter(|| {
- let mut data = AnyMap::new();
- for _ in 0..100 {
- let _ = data.insert(42);
- }
- })
- }
-
- #[bench]
- fn get_missing(b: &mut Bencher) {
- b.iter(|| {
- let data = AnyMap::new();
- for _ in 0..100 {
- assert_eq!(data.get(), None::<&i32>);
- }
- })
- }
-
- #[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));
- }
- })
- }
-
- 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>());
- )*
- })
- }
- );
- }
-
- // 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
- }
-
- 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
- }
-}
-
#[cfg(test)]
mod tests {
- use {Map, AnyMap, Entry};
- use any::{Any, CloneAny};
+ use super::*;
#[derive(Clone, Debug, PartialEq)] struct A(i32);
#[derive(Clone, Debug, PartialEq)] struct B(i32);
}
test_entry!(test_entry_any, AnyMap);
- test_entry!(test_entry_cloneany, Map<CloneAny>);
+ test_entry!(test_entry_cloneany, Map<dyn CloneAny>);
+
+ #[test]
+ fn test_default() {
+ let map: AnyMap = Default::default();
+ assert_eq!(map.len(), 0);
+ }
#[test]
fn test_clone() {
- let mut map: Map<CloneAny> = Map::new();
+ let mut map: Map<dyn CloneAny> = Map::new();
let _ = map.insert(A(1));
let _ = map.insert(B(2));
let _ = map.insert(D(3));
fn assert_send<T: Send>() { }
fn assert_sync<T: Sync>() { }
fn assert_clone<T: Clone>() { }
- fn assert_debug<T: ::std::fmt::Debug>() { }
- assert_send::<Map<Any + Send>>();
- assert_send::<Map<Any + Send + Sync>>();
- assert_sync::<Map<Any + Sync>>();
- assert_sync::<Map<Any + Send + Sync>>();
- assert_debug::<Map<Any>>();
- assert_debug::<Map<Any + Send>>();
- assert_debug::<Map<Any + Sync>>();
- assert_debug::<Map<Any + Send + Sync>>();
- assert_send::<Map<CloneAny + Send>>();
- assert_send::<Map<CloneAny + Send + Sync>>();
- assert_sync::<Map<CloneAny + Sync>>();
- assert_sync::<Map<CloneAny + Send + Sync>>();
- assert_clone::<Map<CloneAny + Send>>();
- assert_clone::<Map<CloneAny + Send + Sync>>();
- assert_clone::<Map<CloneAny + Sync>>();
- assert_clone::<Map<CloneAny + Send + Sync>>();
- assert_debug::<Map<CloneAny>>();
- assert_debug::<Map<CloneAny + Send>>();
- assert_debug::<Map<CloneAny + Sync>>();
- assert_debug::<Map<CloneAny + Send + Sync>>();
+ fn assert_debug<T: ::core::fmt::Debug>() { }
+ assert_send::<Map<dyn Any + Send>>();
+ assert_send::<Map<dyn Any + Send + Sync>>();
+ assert_sync::<Map<dyn Any + Send + Sync>>();
+ assert_debug::<Map<dyn Any>>();
+ assert_debug::<Map<dyn Any + Send>>();
+ assert_debug::<Map<dyn Any + Send + Sync>>();
+ assert_send::<Map<dyn CloneAny + Send>>();
+ assert_send::<Map<dyn CloneAny + Send + Sync>>();
+ assert_sync::<Map<dyn CloneAny + Send + Sync>>();
+ assert_clone::<Map<dyn CloneAny + Send>>();
+ assert_clone::<Map<dyn CloneAny + Send + Sync>>();
+ assert_clone::<Map<dyn CloneAny + Send + Sync>>();
+ assert_debug::<Map<dyn CloneAny>>();
+ assert_debug::<Map<dyn CloneAny + Send>>();
+ assert_debug::<Map<dyn CloneAny + Send + Sync>>();
}
}