X-Git-Url: https://git.chrismorgan.info/anymap/blobdiff_plain/0850f5ec36b14904ae452ffdfa0a2ae0ba05c854..98f2816e62c6f92863214d86f7e7584a1fb49400:/src/raw.rs diff --git a/src/raw.rs b/src/raw.rs index 07dccf8..2b490d8 100644 --- a/src/raw.rs +++ b/src/raw.rs @@ -2,17 +2,15 @@ //! //! All relevant details are in the `RawMap` struct. -use std::any::TypeId; -use std::borrow::Borrow; +use core::any::{Any, TypeId}; +use core::borrow::Borrow; use std::collections::hash_map::{self, HashMap}; -use std::hash::Hash; -use std::hash::{Hasher, BuildHasherDefault}; -#[cfg(test)] -use std::mem; -use std::ops::{Index, IndexMut}; -use std::ptr; +use core::convert::TryInto; +use core::hash::Hash; +use core::hash::{Hasher, BuildHasherDefault}; +use core::ops::{Index, IndexMut}; -use any::{Any, UncheckedAnyExt}; +use crate::any::UncheckedAnyExt; #[derive(Default)] struct TypeIdHasher { @@ -22,11 +20,13 @@ struct TypeIdHasher { impl Hasher for TypeIdHasher { #[inline] fn write(&mut self, bytes: &[u8]) { - // This expects to receive one and exactly one 64-bit value - debug_assert!(bytes.len() == 8); - unsafe { - ptr::copy_nonoverlapping(&bytes[0] as *const u8 as *const u64, &mut self.value, 1) - } + // 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)); } #[inline] @@ -38,7 +38,8 @@ fn type_id_hasher() { fn verify_hashing_with(type_id: TypeId) { let mut hasher = TypeIdHasher::default(); type_id.hash(&mut hasher); - assert_eq!(hasher.finish(), unsafe { mem::transmute::(type_id) }); + // 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::()); @@ -56,7 +57,7 @@ fn type_id_hasher() { /// contents of an `Map`. However, because you will then be dealing with `Any` trait objects, it /// doesn’t tend to be so very useful. Still, if you need it, it’s here. #[derive(Debug)] -pub struct RawMap { +pub struct RawMap { inner: HashMap, BuildHasherDefault>, } @@ -206,10 +207,11 @@ impl RawMap { } /// Inserts a key-value pair from the map. If the key already had a value present in the map, - /// that value is returned. Otherwise, None is returned. + /// that value is returned. Otherwise, `None` is returned. + /// + /// # Safety /// - /// It is the caller’s responsibility to ensure that the key corresponds with the type ID of - /// the value. If they do not, memory safety may be violated. + /// `key` and the type ID of `value` must match, or *undefined behaviour* occurs. #[inline] pub unsafe fn insert(&mut self, key: TypeId, value: Box) -> Option> { self.inner.insert(key, value) @@ -278,8 +280,9 @@ impl<'a, A: ?Sized + UncheckedAnyExt> Entry<'a, A> { /// Ensures a value is in the entry by inserting the default if empty, and returns /// a mutable reference to the value in the entry. /// - /// It is the caller’s responsibility to ensure that the key of the entry corresponds with - /// the type ID of `value`. If they do not, memory safety may be violated. + /// # Safety + /// + /// The type ID of `default` must match the entry’s key, or *undefined behaviour* occurs. #[inline] pub unsafe fn or_insert(self, default: Box) -> &'a mut A { match self { @@ -291,8 +294,10 @@ impl<'a, A: ?Sized + UncheckedAnyExt> Entry<'a, A> { /// 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. /// - /// It is the caller’s responsibility to ensure that the key of the entry corresponds with - /// the type ID of `value`. If they do not, memory safety may be violated. + /// # Safety + /// + /// The type ID of the value returned by `default` must match the entry’s key, + /// or *undefined behaviour* occurs. #[inline] pub unsafe fn or_insert_with Box>(self, default: F) -> &'a mut A { match self { @@ -324,8 +329,9 @@ impl<'a, A: ?Sized + UncheckedAnyExt> OccupiedEntry<'a, A> { /// Sets the value of the entry, and returns the entry's old value. /// - /// It is the caller’s responsibility to ensure that the key of the entry corresponds with - /// the type ID of `value`. If they do not, memory safety may be violated. + /// # Safety + /// + /// The type ID of `value` must match the entry’s key, or *undefined behaviour* occurs. #[inline] pub unsafe fn insert(&mut self, value: Box) -> Box { self.inner.insert(value) @@ -340,10 +346,11 @@ impl<'a, A: ?Sized + UncheckedAnyExt> OccupiedEntry<'a, A> { impl<'a, A: ?Sized + UncheckedAnyExt> VacantEntry<'a, A> { /// Sets the value of the entry with the VacantEntry's key, - /// and returns a mutable reference to it + /// and returns a mutable reference to it. + /// + /// # Safety /// - /// It is the caller’s responsibility to ensure that the key of the entry corresponds with - /// the type ID of `value`. If they do not, memory safety may be violated. + /// The type ID of `value` must match the entry’s key, or *undefined behaviour* occurs. #[inline] pub unsafe fn insert(self, value: Box) -> &'a mut A { &mut **self.inner.insert(value)