j/Conlang
1
1
Fork 0
Code Issues 5 Pull Requests Packages Projects 2 Releases Wiki Activity

cl-structures: intern_pool isn't unsafe

Browse Source 
Nor is it an intern pool, it's more of an unstable typed arena. Ah well.
This commit is contained in:
John 2024-04-24 17:00:58 -05:00
parent 8453b092f1
commit f24bd10c53
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
compiler/cl-structures/src/intern_pool.rs
View File

@ -40,7 +40,7 @@ macro_rules! make_intern_key {($($(#[$meta:meta])* $name:ident),*$(,)?) => {$(
/// # Safety /// # Safety
/// ///
/// The provided value should be within the bounds of its associated container /// The provided value should be within the bounds of its associated container
unsafe fn from_raw_unchecked(value: usize) -> Self { fn from_raw_unchecked(value: usize) -> Self {
Self(value) Self(value)
} }
fn get(&self) -> usize { fn get(&self) -> usize {
@ -70,7 +70,7 @@ pub trait InternKey: std::fmt::Debug {
/// The provided value should be within the bounds of its associated container. /// The provided value should be within the bounds of its associated container.
// ID::from_raw_unchecked here isn't *actually* unsafe, since bounds should always be // ID::from_raw_unchecked here isn't *actually* unsafe, since bounds should always be
// checked, however, the function has unverifiable preconditions. // checked, however, the function has unverifiable preconditions.
unsafe fn from_raw_unchecked(value: usize) -> Self; fn from_raw_unchecked(value: usize) -> Self;
/// Gets the index of the [`InternKey`] by value /// Gets the index of the [`InternKey`] by value
fn get(&self) -> usize; fn get(&self) -> usize;
} }
@ -107,13 +107,13 @@ impl<T, ID: InternKey> Pool<T, ID> {
} }
pub fn key_iter(&self) -> iter::InternKeyIter<ID> { pub fn key_iter(&self) -> iter::InternKeyIter<ID> {
// Safety: Pool currently has pool.len() entries, and data cannot be removed // Safety: Pool currently has pool.len() entries, and data cannot be removed
unsafe { InternKeyIter::new(0..self.pool.len()) } InternKeyIter::new(0..self.pool.len())
} }
/// Constructs an [ID](InternKey) from a [usize], if it's within bounds /// Constructs an [ID](InternKey) from a [usize], if it's within bounds
#[doc(hidden)] #[doc(hidden)]
pub fn try_key_from(&self, value: usize) -> Option<ID> { pub fn try_key_from(&self, value: usize) -> Option<ID> {
(value < self.pool.len()).then(|| unsafe { ID::from_raw_unchecked(value) }) (value < self.pool.len()).then(|| ID::from_raw_unchecked(value))
} }
pub fn insert(&mut self, value: T) -> ID { pub fn insert(&mut self, value: T) -> ID {
@ -121,7 +121,7 @@ impl<T, ID: InternKey> Pool<T, ID> {
self.pool.push(value); self.pool.push(value);
// Safety: value was pushed to `self.pool[id]` // Safety: value was pushed to `self.pool[id]`
unsafe { ID::from_raw_unchecked(id) } ID::from_raw_unchecked(id)
} }
} }
@ -173,7 +173,7 @@ mod iter {
/// - Range must not exceed bounds of the associated [Pool](super::Pool) /// - Range must not exceed bounds of the associated [Pool](super::Pool)
/// - Items must not be removed from the pool /// - Items must not be removed from the pool
/// - Items must be contiguous within the pool /// - Items must be contiguous within the pool
pub(super) unsafe fn new(range: Range<usize>) -> Self { pub(super) fn new(range: Range<usize>) -> Self {
Self { range, _id: Default::default() } Self { range, _id: Default::default() }
} }
} }
@ -183,7 +183,7 @@ mod iter {
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
// Safety: InternKeyIter can only be created by InternKeyIter::new() // Safety: InternKeyIter can only be created by InternKeyIter::new()
Some(unsafe { ID::from_raw_unchecked(self.range.next()?) }) Some(ID::from_raw_unchecked(self.range.next()?))
} }
fn size_hint(&self) -> (usize, Option<usize>) { fn size_hint(&self) -> (usize, Option<usize>) {
self.range.size_hint() self.range.size_hint()
@ -192,7 +192,7 @@ mod iter {
impl<ID: InternKey> DoubleEndedIterator for InternKeyIter<ID> { impl<ID: InternKey> DoubleEndedIterator for InternKeyIter<ID> {
fn next_back(&mut self) -> Option<Self::Item> { fn next_back(&mut self) -> Option<Self::Item> {
// Safety: see above // Safety: see above
Some(unsafe { ID::from_raw_unchecked(self.range.next_back()?) }) Some(ID::from_raw_unchecked(self.range.next_back()?))
} }
} }
impl<ID: InternKey> ExactSizeIterator for InternKeyIter<ID> {} impl<ID: InternKey> ExactSizeIterator for InternKeyIter<ID> {}