boa-dev · radudiaconu0 · Mar 22, 2025 · Mar 23, 2025 · Mar 24, 2025 · Mar 27, 2025
diff --git a/ABOUT.md b/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -47,6 +47,7 @@ boa_string = { version = "~0.20.0", path = "core/string" }
 
 # Utility Repo Crates
 tag_ptr = { path = "utils/tag_ptr" }
+small_map = { path = "utils/small_map" }
 
 # Shared deps
 arbitrary = "1"

diff --git a/cli/ABOUT.md b/cli/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/ast/ABOUT.md b/core/ast/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/engine/ABOUT.md b/core/engine/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/engine/Cargo.toml b/core/engine/Cargo.toml
@@ -92,6 +92,7 @@ ryu-js.workspace = true
 fast-float2.workspace = true
 once_cell = { workspace = true, features = ["std"] }
 tap.workspace = true
+small_map.workspace = true
 
 thiserror.workspace = true
 dashmap.workspace = true

diff --git a/core/engine/src/builtins/atomics/futex.rs b/core/engine/src/builtins/atomics/futex.rs
@@ -154,10 +154,9 @@ mod sync {
 
     use intrusive_collections::{intrusive_adapter, LinkedList, LinkedListLink, UnsafeRef};
 
-    use crate::{
-        small_map::{Entry, SmallMap},
-        JsNativeError, JsResult,
-    };
+    use small_map::{Entry, SmallMap};
+
+    use crate::{JsNativeError, JsResult};
 
     /// A waiter of a memory address.
     #[derive(Debug, Default)]

diff --git a/core/engine/src/lib.rs b/core/engine/src/lib.rs
@@ -103,7 +103,6 @@ pub mod value;
 pub mod vm;
 
 mod host_defined;
-mod small_map;
 mod sys;
 
 mod spanned_source_text;

diff --git a/core/engine/src/module/loader.rs b/core/engine/src/module/loader.rs
@@ -56,7 +56,7 @@ pub fn resolve_module_specifier(
 
     // On Windows, also replace `/` with `\`. JavaScript imports use `/` as path separator.
     #[cfg(target_family = "windows")]
-    let specifier = specifier.replace("/", "\\");
+    let specifier = specifier.replace('/', "\\");
 
     let short_path = Path::new(&specifier);
 

diff --git a/core/gc/ABOUT.md b/core/gc/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/

diff --git a/core/icu_provider/ABOUT.md b/core/icu_provider/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/

diff --git a/core/interner/ABOUT.md b/core/interner/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/

diff --git a/core/macros/ABOUT.md b/core/macros/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/parser/ABOUT.md b/core/parser/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/profiler/ABOUT.md b/core/profiler/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that add SmallMap data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/runtime/ABOUT.md b/core/runtime/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/core/string/ABOUT.md b/core/string/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli
diff --git a/utils/small_map/ABOUT.md b/utils/small_map/ABOUT.md
@@ -0,0 +1,42 @@
+# About Boa
+
+Boa is an open-source, experimental ECMAScript Engine written in Rust for
+lexing, parsing and executing ECMAScript/JavaScript. Currently, Boa supports some
+of the [language][boa-conformance]. More information can be viewed at [Boa's
+website][boa-web].
+
+Try out the most recent release with Boa's live demo
+[playground][boa-playground].
+
+## Boa Crates
+
+- [**`boa_cli`**][cli] - Boa's CLI && REPL implementation
+- [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
+- [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and execution.
+- [**`boa_gc`**][gc] - Boa's garbage collector.
+- [**`boa_icu_provider`**][icu] - Boa's ICU4X data provider.
+- [**`boa_interner`**][interner] - Boa's string interner.
+- [**`boa_macros`**][macros] - Boa's macros.
+- [**`boa_parser`**][parser] - Boa's lexer and parser.
+- [**`boa_profiler`**][profiler] - Boa's code profiler.
+- [**`boa_runtime`**][runtime] - Boa's WebAPI features.
+- [**`boa_string`**][string] - Boa's ECMAScript string implementation.
+- [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
+
+[boa-conformance]: https://boajs.dev/conformance
+[boa-web]: https://boajs.dev/
+[boa-playground]: https://boajs.dev/playground
+[ast]: https://docs.rs/boa_ast/latest/boa_ast/index.html
+[engine]: https://docs.rs/boa_engine/latest/boa_engine/index.html
+[gc]: https://docs.rs/boa_gc/latest/boa_gc/index.html
+[interner]: https://docs.rs/boa_interner/latest/boa_interner/index.html
+[parser]: https://docs.rs/boa_parser/latest/boa_parser/index.html
+[profiler]: https://docs.rs/boa_profiler/latest/boa_profiler/index.html
+[icu]: https://docs.rs/boa_icu_provider/latest/boa_icu_provider/index.html
+[runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
+[string]: https://docs.rs/boa_string/latest/boa_string/index.html
+[tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
+[macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
+[cli]: https://crates.io/crates/boa_cli
diff --git a/utils/small_map/Cargo.toml b/utils/small_map/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "small_map"
+keywords = ["small", "map"]
+categories = ["data-structures"]
+readme = "../../README.md"
+description = "Utility library that add SmallMap data structure"
+version = "0.1.0"
+edition.workspace = true
+authors.workspace = true
+license.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+
+
+[lints]
+workspace = true
+
+[package.metadata.docs.rs]
+all-features = true
+
+[dependencies]
+arrayvec.workspace = true
diff --git a/core/engine/src/small_map/entry.rs → utils/small_map/src/entry.rs b/core/engine/src/small_map/entry.rs → utils/small_map/src/entry.rs
@@ -114,6 +114,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> Entry<'a, K, V, ARRAY_SIZE> {
 
     /// Provides in-place mutable access to an occupied entry before any
     /// potential inserts into the map.
+    #[must_use]
     pub fn and_modify<F>(self, f: F) -> Self
     where
         F: FnOnce(&mut V),
@@ -169,6 +170,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> VacantEntry<'a, K, V, ARRAY_SIZE> {
 
 impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE> {
     /// Gets a reference to the key in the entry.
+    #[must_use]
     pub fn key(&self) -> &K {
         match &self.inner {
             InnerOccupied::Inline(o) => o.key(),
@@ -177,6 +179,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE>
     }
 
     /// Takes ownership of the key and value from the map.
+    #[must_use]
     pub fn remove_entry(self) -> (K, V) {
         match self.inner {
             InnerOccupied::Inline(o) => o.remove_entry(),
@@ -185,6 +188,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE>
     }
 
     /// Gets a reference to the value in the entry.
+    #[must_use]
     pub fn get(&self) -> &V {
         match &self.inner {
             InnerOccupied::Inline(o) => o.get(),
@@ -210,6 +214,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE>
     /// If you need multiple references to the `OccupiedEntry`, see [`get_mut`].
     ///
     /// [`get_mut`]: OccupiedEntry::get_mut
+    #[must_use]
     pub fn into_mut(self) -> &'a mut V {
         match self.inner {
             InnerOccupied::Inline(o) => o.into_mut(),
@@ -219,6 +224,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE>
 
     /// Sets the value of the entry with the `OccupiedEntry`'s key,
     /// and returns the entry's old value.
+    #[must_use]
     pub fn insert(&mut self, value: V) -> V {
         match &mut self.inner {
             InnerOccupied::Inline(o) => o.insert(value),
@@ -227,6 +233,7 @@ impl<'a, K: Ord, V, const ARRAY_SIZE: usize> OccupiedEntry<'a, K, V, ARRAY_SIZE>
     }
 
     /// Takes the value of the entry out of the map, and returns it.
+    #[must_use]
     pub fn remove(self) -> V {
         match self.inner {
             InnerOccupied::Inline(o) => o.remove(),

diff --git a/core/engine/src/small_map/mod.rs → utils/small_map/src/lib.rs b/core/engine/src/small_map/mod.rs → utils/small_map/src/lib.rs
@@ -1,6 +1,9 @@
-// TODO: Maybe extract to a separate crate? It could be useful for some applications.
-#![allow(unreachable_pub)]
-#![allow(unused)]
+//! A crate that provides a `SmallMap` collection, which is initially backed by an inline vec
+//! but changes its backing to a heap map if its number of elements exceeds `ARRAY_SIZE`.
+//!
+//! This provides performance benefits for maps that are expected to be small most of the time,
+//! by avoiding heap allocations for the common case while still supporting larger collections when needed.
+
 
 use std::{
     borrow::Borrow,
@@ -22,7 +25,7 @@ use Entry::{Occupied, Vacant};
 /// A map that is initially backed by an inline vec, but changes its backing to a heap map if its
 /// number of elements exceeds `ARRAY_SIZE`.
 #[derive(Clone)]
-pub(crate) struct SmallMap<K, V, const ARRAY_SIZE: usize> {
+pub struct SmallMap<K, V, const ARRAY_SIZE: usize> {
     inner: Inner<K, V, ARRAY_SIZE>,
 }
 
@@ -137,6 +140,7 @@ impl<K, V, const ARRAY_SIZE: usize> Default for IntoIter<K, V, ARRAY_SIZE> {
 
 impl<K, V, const ARRAY_SIZE: usize> SmallMap<K, V, ARRAY_SIZE> {
     /// Makes a new, empty `SmallMap`.
+    #[must_use]
     pub const fn new() -> Self {
         Self {
             inner: Inner::Inline(ArrayVec::new_const()),

diff --git a/utils/tag_ptr/ABOUT.md b/utils/tag_ptr/ABOUT.md
@@ -22,6 +22,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_runtime`**][runtime] - Boa's WebAPI features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
+- [**`small_map`**][small_map] - Utility library that adds the `SmallMap` data structure.
 
 [boa-conformance]: https://boajs.dev/conformance
 [boa-web]: https://boajs.dev/
@@ -36,5 +37,6 @@ Try out the most recent release with Boa's live demo
 [runtime]: https://docs.rs/boa_runtime/latest/boa_runtime/index.html
 [string]: https://docs.rs/boa_string/latest/boa_string/index.html
 [tag_ptr]: https://docs.rs/tag_ptr/latest/tag_ptr/index.html
+[small_map]: https://docs.rs/small_map/latest/small_map/index.html
 [macros]: https://docs.rs/boa_macros/latest/boa_macros/index.html
 [cli]: https://crates.io/crates/boa_cli