Separate JsObjectType implementors to their own module (#2324)

This Pull Request closes #2080.

It moves all implementors of the `JsObjectType` trait into their own `js_object` module.
This should simplify documentation and by doing a `pub(crate)` export in `object` little to no imports within the crate need to be changed, simplifying the usage of this module within the boa_engine crate.
Documentation within the `object` module has been updated to reflect this change and in a way that it is shown on the home page of the documentation.

boa_engine/src/object/builtins/jsdataview.rs

@@ -17,7 +17,7 @@ use std::ops::Deref;
 /// # Examples
 /// ```
 /// # use boa_engine::{
-/// #     object::{JsArrayBuffer, JsDataView},
+/// #     object::builtins::{JsArrayBuffer, JsDataView},
 /// #     Context, JsValue
 /// # };
 ///

boa_engine/src/object/builtins/jsmap.rs

@@ -16,7 +16,7 @@ use std::ops::Deref;
 /// Create a `JsMap` and set a new entry
 /// ```
 /// # use boa_engine::{
-/// #  object::JsMap,
+/// #  object::builtins::JsMap,
 /// #  Context, JsValue,
 /// # };
 ///
@@ -37,7 +37,7 @@ use std::ops::Deref;
 /// Create a `JsMap` from a `JsArray`
 /// ```
 /// # use boa_engine::{
-/// #    object::{JsArray, JsMap},
+/// #    object::builtins::{JsArray, JsMap},
 /// #    Context, JsValue,
 /// # };
 ///
@@ -46,7 +46,7 @@ use std::ops::Deref;
 ///
 /// // Create an array of two `[key, value]` pairs
 /// let js_array = JsArray::new(context);
-///     
+///
 /// // Create a `[key, value]` pair of JsValues
 /// let vec_one: Vec<JsValue> = vec![JsValue::new("first-key"), JsValue::new("first-value")];
 ///
@@ -72,7 +72,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -94,7 +94,7 @@ impl JsMap {
     /// # Examples
     /// ```
     /// # use boa_engine::{
-    /// #    object::{JsArray, JsMap},
+    /// #    object::builtins::{JsArray, JsMap},
     /// #    Context, JsResult, JsValue,
     /// # };
     ///
@@ -103,7 +103,7 @@ impl JsMap {
     ///
     /// // Create an array of two `[key, value]` pairs
     /// let js_array = JsArray::new(context);
-    ///     
+    ///
     /// // Create a `[key, value]` pair of JsValues and add it to the `JsArray` as a `JsArray`
     /// let vec_one: Vec<JsValue> = vec![JsValue::new("first-key"), JsValue::new("first-value")];
     /// js_array.push(JsArray::from_iter(vec_one, context), context).unwrap();
@@ -136,7 +136,7 @@ impl JsMap {
     /// ```
     /// # use boa_engine::{
     /// #    builtins::map::ordered_map::OrderedMap,
-    /// #    object::{JsObject, ObjectData, JsMap},
+    /// #    object::{builtins::JsMap, JsObject, ObjectData},
     /// #    Context, JsValue,
     /// # };
     ///
@@ -147,7 +147,7 @@ impl JsMap {
     ///     context.intrinsics().constructors().map().prototype(),
     ///     ObjectData::map(OrderedMap::new())
     /// );
-    ///     
+    ///
     /// // Create `JsMap` object with incoming object.
     /// let js_map = JsMap::from_object(some_object, context).unwrap();
     ///
@@ -156,7 +156,7 @@ impl JsMap {
     /// Invalid Example - returns a `TypeError` with the message "object is not a Map"
     /// ```
     /// # use boa_engine::{
-    /// #    object::{JsObject, JsArray, JsMap},
+    /// #    object::{JsObject, builtins::{JsArray, JsMap}},
     /// #    Context, JsResult, JsValue,
     /// # };
     ///
@@ -166,7 +166,7 @@ impl JsMap {
     ///
     /// // Some object is an Array object, not a map object
     /// assert!(JsMap::from_object(some_object.into(), context).is_err());
-    ///     
+    ///
     /// ```
     #[inline]
     pub fn from_object(object: JsObject, context: &mut Context) -> JsResult<Self> {
@@ -210,7 +210,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -223,7 +223,7 @@ impl JsMap {
     ///
     /// assert_eq!(js_map.get("foo", context).unwrap(), "bar".into());
     /// assert_eq!(js_map.get(2, context).unwrap(), 4.into())
-    ///     
+    ///
     /// ```
     #[inline]
     pub fn set<K, V>(&self, key: K, value: V, context: &mut Context) -> JsResult<JsValue>
@@ -244,7 +244,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -270,7 +270,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -300,7 +300,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -327,7 +327,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///
@@ -353,7 +353,7 @@ impl JsMap {
     ///
     /// ```
     /// # use boa_engine::{
-    /// #    object::JsMap,
+    /// #    object::builtins::JsMap,
     /// #    Context, JsValue,
     /// # };
     ///

boa_engine/src/object/builtins/jsproxy.rs

@@ -2,10 +2,11 @@ use boa_gc::{Finalize, Trace};
 
 use crate::{
     builtins::{function::NativeFunctionSignature, Proxy},
+    object::{FunctionBuilder, JsObject, JsObjectType, ObjectData},
     Context, JsResult, JsValue,
 };
 
-use super::{FunctionBuilder, JsFunction, JsObject, JsObjectType, ObjectData};
+use super::JsFunction;
 
 /// JavaScript [`Proxy`][proxy] rust object.
 ///

boa_engine/src/object/builtins/jsset.rs

@@ -8,7 +8,7 @@ use crate::{
     Context, JsResult, JsValue,
 };
 
-// This is an wrapper for `JsSet`
+/// JavaScript `Set` rust object.
 #[derive(Debug, Clone, Trace, Finalize)]
 pub struct JsSet {
     inner: JsObject,

boa_engine/src/object/builtins/mod.rs

@@ -0,0 +1,23 @@
+//! Contains all the Rust representations of JavaScript objects.
+
+mod jsarray;
+mod jsarraybuffer;
+mod jsdataview;
+mod jsfunction;
+mod jsmap;
+mod jsmap_iterator;
+pub(crate) mod jsproxy;
+mod jsset;
+mod jsset_iterator;
+mod jstypedarray;
+
+pub use jsarray::*;
+pub use jsarraybuffer::*;
+pub use jsdataview::*;
+pub use jsfunction::*;
+pub use jsmap::*;
+pub use jsmap_iterator::*;
+pub use jsproxy::{JsProxy, JsRevocableProxy};
+pub use jsset::*;
+pub use jsset_iterator::*;
+pub use jstypedarray::*;

boa_engine/src/object/mod.rs

@@ -1,6 +1,8 @@
-//! This module implements the Rust representation of a JavaScript object.
+//! This module implements the Rust representation of a JavaScript object, see object::[builtins] for implementors.
+//!
+//! This module also provides helper objects for working with JavaScript objects.
 
-pub use jsobject::{JsObject, RecursionLimiter, Ref, RefMut};
+pub use jsobject::{RecursionLimiter, Ref, RefMut};
 pub use operations::IntegrityLevel;
 pub use property_map::*;
 
@@ -63,30 +65,16 @@ use std::{
 mod tests;
 
 pub(crate) mod internal_methods;
-mod jsarray;
+
-mod jsarraybuffer;
+pub mod builtins;
-mod jsdataview;
-mod jsfunction;
-mod jsmap;
-mod jsmap_iterator;
 mod jsobject;
-mod jsproxy;
-mod jsset;
-mod jsset_iterator;
-mod jstypedarray;
 mod operations;
 mod property_map;
 
-pub use jsarray::*;
+pub(crate) use builtins::*;
-pub use jsarraybuffer::*;
+
-pub use jsdataview::*;
+pub use builtins::jsproxy::JsProxyBuilder;
-pub use jsfunction::*;
+pub use jsobject::*;
-pub use jsmap::*;
-pub use jsmap_iterator::*;
-pub use jsproxy::*;
-pub use jsset::*;
-pub use jsset_iterator::*;
-pub use jstypedarray::*;
 
 pub(crate) trait JsObjectType:
     Into<JsValue> + Into<JsObject> + Deref<Target = JsObject>

boa_examples/src/bin/jsarray.rs

@@ -1,7 +1,7 @@
 // This example shows how to manipulate a Javascript array using Rust code.
 
 use boa_engine::{
-    object::{FunctionBuilder, JsArray},
+    object::{builtins::JsArray, FunctionBuilder},
     Context, JsResult, JsValue,
 };
 

boa_examples/src/bin/jsarraybuffer.rs

@@ -1,7 +1,7 @@
 // This example shows how to manipulate a Javascript array using Rust code.
 
 use boa_engine::{
-    object::{JsArrayBuffer, JsDataView, JsUint32Array, JsUint8Array},
+    object::builtins::{JsArrayBuffer, JsDataView, JsUint32Array, JsUint8Array},
     property::Attribute,
     Context, JsResult, JsValue,
 };

boa_examples/src/bin/jsmap.rs

@@ -1,5 +1,5 @@
 use boa_engine::{
-    object::{JsArray, JsMap},
+    object::{builtins::JsArray, builtins::JsMap},
     Context, JsResult, JsValue,
 };
 

boa_examples/src/bin/jsset.rs

@@ -1,6 +1,6 @@
 // This example shows how to manipulate a Javascript Set using Rust code.
 #![allow(clippy::bool_assert_comparison)]
-use boa_engine::{object::JsSet, Context, JsValue};
+use boa_engine::{object::builtins::JsSet, Context, JsValue};
 
 fn main() -> Result<(), JsValue> {
     // New `Context` for a new Javascript executor.

boa_examples/src/bin/jstypedarray.rs

@@ -1,7 +1,7 @@
 // This example shows how to manipulate a Javascript array using Rust code.
 
 use boa_engine::{
-    object::{FunctionBuilder, JsUint8Array},
+    object::{builtins::JsUint8Array, FunctionBuilder},
     property::Attribute,
     Context, JsResult, JsValue,
 };