Skip to content

A lightweight WebAssembly runtime that is fast, secure, and standards-compliant

Rename our OOM-handling `BTreeMap` to `TryBTreeMap` (#12747)

Nick Fitzgeraldfd30f52f6a46
diff --git a/crates/environ/examples/btrees.rs b/crates/environ/examples/btrees.rs
index e93fb1812d..90e9969cb5 100644
--- a/crates/environ/examples/btrees.rs
+++ b/crates/environ/examples/btrees.rs
@@ -18,9 +18,9 @@ impl Map for BTreeMap<Key, Value> {
}
}
-impl Map for collections::BTreeMap<Key, Value> {
+impl Map for collections::TryBTreeMap<Key, Value> {
fn insert(&mut self, key: Key, value: Value) -> Result<()> {
- collections::BTreeMap::insert(self, key, value)?;
+ collections::TryBTreeMap::insert(self, key, value)?;
Ok(())
}
}
@@ -32,7 +32,7 @@ fn main() -> Result<()> {
let mut map: Box<dyn Map> = match kind.as_str() {
"std" => Box::new(BTreeMap::new()),
- "bforest" => Box::new(collections::BTreeMap::new()),
+ "bforest" => Box::new(collections::TryBTreeMap::new()),
_ => bail!("first argument must be either 'std' or 'bforest', got: '{kind}'"),
};
diff --git a/crates/environ/src/collections.rs b/crates/environ/src/collections.rs
index c477563265..be7e4cc369 100644
--- a/crates/environ/src/collections.rs
+++ b/crates/environ/src/collections.rs
@@ -8,7 +8,7 @@ mod index_map;
mod primary_map;
mod secondary_map;
-pub use btree_map::BTreeMap;
+pub use btree_map::TryBTreeMap;
pub use entity_set::TryEntitySet;
pub use hash_map::TryHashMap;
pub use hash_set::TryHashSet;
diff --git a/crates/environ/src/collections/btree_map.rs b/crates/environ/src/collections/btree_map.rs
index 29b795ff41..e52d516746 100644
--- a/crates/environ/src/collections/btree_map.rs
+++ b/crates/environ/src/collections/btree_map.rs
@@ -1,4 +1,4 @@
-//! OOM-handling `BTreeMap` implementation.
+//! OOM-handling `TryBTreeMap` implementation.
use crate::error::OutOfMemory;
use core::{mem, ops::RangeBounds, ptr::NonNull};
@@ -6,7 +6,7 @@ use wasmtime_core::slab::{Id, Slab};
/// Like `std::collections::BTreeMap` but its methods return errors on
/// allocation failure.
-pub struct BTreeMap<K, V>
+pub struct TryBTreeMap<K, V>
where
K: Copy,
{
@@ -15,7 +15,7 @@ where
map: cranelift_bforest::Map<K, Id>,
}
-impl<K, V> Default for BTreeMap<K, V>
+impl<K, V> Default for TryBTreeMap<K, V>
where
K: Copy,
{
@@ -28,7 +28,7 @@ where
}
}
-impl<K, V> BTreeMap<K, V>
+impl<K, V> TryBTreeMap<K, V>
where
K: Copy,
{
@@ -205,7 +205,7 @@ where
}
}
-impl<'a, K, V> IntoIterator for &'a BTreeMap<K, V>
+impl<'a, K, V> IntoIterator for &'a TryBTreeMap<K, V>
where
K: Copy,
{
@@ -217,7 +217,7 @@ where
}
}
-/// An iterator over `(K, &V)` pairs returned by [`BTreeMap::iter`].
+/// An iterator over `(K, &V)` pairs returned by [`TryBTreeMap::iter`].
pub struct BTreeMapIter<'a, K, V>
where
K: Copy,
@@ -242,7 +242,7 @@ where
}
}
-impl<'a, K, V> IntoIterator for &'a mut BTreeMap<K, V>
+impl<'a, K, V> IntoIterator for &'a mut TryBTreeMap<K, V>
where
K: Copy,
{
@@ -254,7 +254,7 @@ where
}
}
-/// An iterator over `(K, &mut V)` pairs returned by [`BTreeMap::iter_mut`].
+/// An iterator over `(K, &mut V)` pairs returned by [`TryBTreeMap::iter_mut`].
pub struct BTreeMapIterMut<'a, K, V>
where
K: Copy,
@@ -286,7 +286,7 @@ where
}
}
-impl<K, V> IntoIterator for BTreeMap<K, V>
+impl<K, V> IntoIterator for TryBTreeMap<K, V>
where
K: Copy + Ord,
{
@@ -301,7 +301,7 @@ where
}
}
-/// An iterator over `(K, V)` pairs returned by [`BTreeMap::into_iter`].
+/// An iterator over `(K, V)` pairs returned by [`TryBTreeMap::into_iter`].
pub struct BTreeMapIntoIter<K, V>
where
K: Copy,
@@ -328,7 +328,7 @@ where
}
}
-/// An iterator over keys returned by [`BTreeMap::keys`].
+/// An iterator over keys returned by [`TryBTreeMap::keys`].
pub struct BTreeMapKeys<'a, K, V>
where
K: Copy,
@@ -348,7 +348,7 @@ where
}
}
-/// An iterator over shared values returned by [`BTreeMap::values`].
+/// An iterator over shared values returned by [`TryBTreeMap::values`].
pub struct BTreeMapValues<'a, K, V>
where
K: Copy,
@@ -368,7 +368,7 @@ where
}
}
-/// An iterator over mutable values returned by [`BTreeMap::values_mut`].
+/// An iterator over mutable values returned by [`TryBTreeMap::values_mut`].
pub struct BTreeMapValuesMut<'a, K, V>
where
K: Copy,
@@ -388,7 +388,7 @@ where
}
}
-/// A range iterator of `(K, &'a V)` items returned by [`BTreeMap::range`].
+/// A range iterator of `(K, &'a V)` items returned by [`TryBTreeMap::range`].
pub struct BTreeMapRange<'a, K, V, R>
where
K: Copy + Ord,
@@ -411,7 +411,7 @@ where
}
}
-/// A range iterator of `(K, &'a V)` items returned by [`BTreeMap::range`].
+/// A range iterator of `(K, &'a V)` items returned by [`TryBTreeMap::range`].
pub struct BTreeMapRangeMut<'a, K, V, R>
where
K: Copy + Ord,
@@ -651,7 +651,7 @@ mod tests {
use crate::error::Result;
use alloc::{vec, vec::Vec};
- type M = BTreeMap<usize, f32>;
+ type M = TryBTreeMap<usize, f32>;
#[test]
fn new() -> Result<()> {
diff --git a/crates/environ/src/prelude.rs b/crates/environ/src/prelude.rs
index 02d68966e3..47d6b88474 100644
--- a/crates/environ/src/prelude.rs
+++ b/crates/environ/src/prelude.rs
@@ -20,9 +20,9 @@
//! and then `use crate::*` works as usual.
pub use crate::collections::{
- TryClone, TryCollect, TryEntitySet, TryExtend, TryFromIterator, TryHashMap, TryHashSet,
- TryIndexMap, TryNew, TryPrimaryMap, TrySecondaryMap, TryString, TryToOwned, TryVec, try_new,
- try_vec,
+ TryBTreeMap, TryClone, TryCollect, TryEntitySet, TryExtend, TryFromIterator, TryHashMap,
+ TryHashSet, TryIndexMap, TryNew, TryPrimaryMap, TrySecondaryMap, TryString, TryToOwned, TryVec,
+ try_new, try_vec,
};
pub use crate::error::{Context, Error, Result, bail, ensure, format_err};
pub use alloc::borrow::ToOwned;
diff --git a/crates/fuzzing/tests/oom/btree_map.rs b/crates/fuzzing/tests/oom/btree_map.rs
index c03fa113e6..1d0d50e51f 100644
--- a/crates/fuzzing/tests/oom/btree_map.rs
+++ b/crates/fuzzing/tests/oom/btree_map.rs
@@ -1,8 +1,8 @@
use wasmtime::Result;
-use wasmtime_environ::collections::{BTreeMap, btree_map::Entry};
+use wasmtime_environ::collections::{TryBTreeMap, btree_map::Entry};
use wasmtime_fuzzing::oom::OomTest;
-type M = BTreeMap<usize, f32>;
+type M = TryBTreeMap<usize, f32>;
#[test]
fn btree_map() -> Result<()> {