From 22ce2173fe72789abc26dba3acc55a89b74baa0e Mon Sep 17 00:00:00 2001 From: Aapo Alasuutari Date: Wed, 18 Mar 2026 20:56:44 +0200 Subject: [PATCH] chore(docs): Hide internal AsRef and AsMut docs --- .../promise_group_record.rs | 2 ++ .../src/ecmascript/builtins/ordinary/shape.rs | 4 ++++ .../typed_array/normal_typed_array.rs | 2 ++ .../typed_array/shared_typed_array.rs | 6 ++++-- .../src/ecmascript/execution/environments.rs | 8 ++++++-- .../module/module_semantics.rs | 2 ++ .../source_text_module_records.rs | 2 ++ nova_vm/src/heap.rs | 20 +++++++++++++++---- nova_vm/src/heap/element_array.rs | 2 ++ 9 files changed, 40 insertions(+), 8 deletions(-) diff --git a/nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_group_record.rs b/nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_group_record.rs index 85c823162..400150403 100644 --- a/nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_group_record.rs +++ b/nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_group_record.rs @@ -233,12 +233,14 @@ impl<'a> PromiseGroup<'a> { } } +#[doc(hidden)] impl AsRef<[PromiseGroupRecord<'static>]> for Agent { fn as_ref(&self) -> &[PromiseGroupRecord<'static>] { &self.heap.promise_group_records } } +#[doc(hidden)] impl AsMut<[PromiseGroupRecord<'static>]> for Agent { fn as_mut(&mut self) -> &mut [PromiseGroupRecord<'static>] { &mut self.heap.promise_group_records diff --git a/nova_vm/src/ecmascript/builtins/ordinary/shape.rs b/nova_vm/src/ecmascript/builtins/ordinary/shape.rs index 057436a5e..da49bfe62 100644 --- a/nova_vm/src/ecmascript/builtins/ordinary/shape.rs +++ b/nova_vm/src/ecmascript/builtins/ordinary/shape.rs @@ -1093,6 +1093,7 @@ impl<'a> DirectArenaAccessMut for ObjectShape<'a> { } } +#[doc(hidden)] impl AsRef>> for Agent { #[inline(always)] fn as_ref(&self) -> &Vec> { @@ -1100,6 +1101,7 @@ impl AsRef>> for Agent { } } +#[doc(hidden)] impl AsMut>> for Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec> { @@ -1283,12 +1285,14 @@ impl HeapMarkAndSweep for PrototypeShapeTable { } } +#[doc(hidden)] impl AsRef<[ObjectShapeTransitionMap<'static>]> for Agent { fn as_ref(&self) -> &[ObjectShapeTransitionMap<'static>] { &self.heap.object_shape_transitions } } +#[doc(hidden)] impl AsMut<[ObjectShapeTransitionMap<'static>]> for Agent { fn as_mut(&mut self) -> &mut [ObjectShapeTransitionMap<'static>] { &mut self.heap.object_shape_transitions diff --git a/nova_vm/src/ecmascript/builtins/typed_array/normal_typed_array.rs b/nova_vm/src/ecmascript/builtins/typed_array/normal_typed_array.rs index f514dede0..629d7bf13 100644 --- a/nova_vm/src/ecmascript/builtins/typed_array/normal_typed_array.rs +++ b/nova_vm/src/ecmascript/builtins/typed_array/normal_typed_array.rs @@ -2297,12 +2297,14 @@ impl<'a, T: Viewable> DirectArenaAccessMut for GenericTypedArray<'a, T> { } } } +#[doc(hidden)] impl AsRef>> for Agent { #[inline(always)] fn as_ref(&self) -> &Vec> { &self.heap.typed_arrays } } +#[doc(hidden)] impl AsMut>> for Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec> { diff --git a/nova_vm/src/ecmascript/builtins/typed_array/shared_typed_array.rs b/nova_vm/src/ecmascript/builtins/typed_array/shared_typed_array.rs index cdde6a21f..ece52526f 100644 --- a/nova_vm/src/ecmascript/builtins/typed_array/shared_typed_array.rs +++ b/nova_vm/src/ecmascript/builtins/typed_array/shared_typed_array.rs @@ -2321,13 +2321,15 @@ impl<'a, T: Viewable> DirectArenaAccessMut for GenericSharedTypedArray<'a, T> { } } } -impl AsRef>> for crate::ecmascript::execution::Agent { +#[doc(hidden)] +impl AsRef>> for crate::ecmascript::Agent { #[inline(always)] fn as_ref(&self) -> &Vec> { &self.heap.shared_typed_arrays } } -impl AsMut>> for crate::ecmascript::execution::Agent { +#[doc(hidden)] +impl AsMut>> for crate::ecmascript::Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec> { &mut self.heap.shared_typed_arrays diff --git a/nova_vm/src/ecmascript/execution/environments.rs b/nova_vm/src/ecmascript/execution/environments.rs index 8b83bb691..8c1ea9cee 100644 --- a/nova_vm/src/ecmascript/execution/environments.rs +++ b/nova_vm/src/ecmascript/execution/environments.rs @@ -109,14 +109,16 @@ macro_rules! create_environment_index { } } - impl AsRef> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsRef> for crate::ecmascript::Agent { #[inline(always)] fn as_ref(&self) -> &Vec<$record> { &self.heap.environments.$entry } } - impl AsMut> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsMut> for crate::ecmascript::Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec<$record> { &mut self.heap.environments.$entry @@ -1155,12 +1157,14 @@ impl AsMut for Environments { } } +#[doc(hidden)] impl AsRef for Agent { fn as_ref(&self) -> &Environments { &self.heap.environments } } +#[doc(hidden)] impl AsMut for Agent { fn as_mut(&mut self) -> &mut Environments { &mut self.heap.environments diff --git a/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics.rs b/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics.rs index 3343a25fe..2a1362a3f 100644 --- a/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics.rs +++ b/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics.rs @@ -62,12 +62,14 @@ impl<'a> ModuleRequestRecord<'a> { } } +#[doc(hidden)] impl AsRef<[ModuleRequestRecord<'static>]> for Agent { fn as_ref(&self) -> &[ModuleRequestRecord<'static>] { &self.heap.module_request_records } } +#[doc(hidden)] impl AsMut<[ModuleRequestRecord<'static>]> for Agent { fn as_mut(&mut self) -> &mut [ModuleRequestRecord<'static>] { &mut self.heap.module_request_records diff --git a/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics/source_text_module_records.rs b/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics/source_text_module_records.rs index c12f2dca1..d29bbe6a9 100644 --- a/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics/source_text_module_records.rs +++ b/nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics/source_text_module_records.rs @@ -2247,12 +2247,14 @@ impl AsMut for SourceTextModuleHeap { } } +#[doc(hidden)] impl AsRef for Agent { fn as_ref(&self) -> &SourceTextModuleHeap { &self.heap.source_text_module_records } } +#[doc(hidden)] impl AsMut for Agent { fn as_mut(&mut self) -> &mut SourceTextModuleHeap { &mut self.heap.source_text_module_records diff --git a/nova_vm/src/heap.rs b/nova_vm/src/heap.rs index 905d500a5..b03768df4 100644 --- a/nova_vm/src/heap.rs +++ b/nova_vm/src/heap.rs @@ -720,6 +720,7 @@ fn init_heap() { macro_rules! arena_vec_access { (soa: $name: ident, $lt: lifetime, $data: ident, $member: ident, $output_ref: ident, $output_mut: ident) => { + #[doc(hidden)] impl<$lt> crate::heap::DirectArenaAccessSoA for $name<$lt> { type Data = $data<'static>; @@ -734,6 +735,7 @@ macro_rules! arena_vec_access { } } + #[doc(hidden)] impl<$lt> crate::heap::DirectArenaAccessSoAMut for $name<$lt> { #[inline] fn get_direct_mut<'agent>( @@ -760,14 +762,16 @@ macro_rules! arena_vec_access { } } - impl AsRef>> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsRef>> for crate::ecmascript::Agent { #[inline(always)] fn as_ref(&self) -> &soavec::SoAVec<$data<'static>> { &self.heap.$member } } - impl AsMut>> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsMut>> for crate::ecmascript::Agent { #[inline(always)] fn as_mut(&mut self) -> &mut soavec::SoAVec<$data<'static>> { &mut self.heap.$member @@ -775,6 +779,7 @@ macro_rules! arena_vec_access { } }; ($name: ident, $lt: lifetime, $data: ident, $member: ident) => { + #[doc(hidden)] impl<$lt> crate::heap::DirectArenaAccess for $name<$lt> { type Data = $data<'static>; type Output = $data<$lt>; @@ -787,6 +792,7 @@ macro_rules! arena_vec_access { } } + #[doc(hidden)] impl<$lt> crate::heap::DirectArenaAccessMut for $name<$lt> { #[inline] fn get_direct_mut(self, source: &mut Vec) -> &mut Self::Output { @@ -801,6 +807,7 @@ macro_rules! arena_vec_access { } } + #[doc(hidden)] impl AsRef>> for crate::ecmascript::Agent { #[inline(always)] fn as_ref(&self) -> &Vec<$data<'static>> { @@ -808,6 +815,7 @@ macro_rules! arena_vec_access { } } + #[doc(hidden)] impl AsMut>> for crate::ecmascript::Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec<$data<'static>> { @@ -816,6 +824,7 @@ macro_rules! arena_vec_access { } }; ($name: ident, $data: ty, $member: ident, $output: ty) => { + #[doc(hidden)] impl crate::heap::DirectArenaAccess for $name<'_> { type Data = $data; type Output = $output; @@ -828,6 +837,7 @@ macro_rules! arena_vec_access { } } + #[doc(hidden)] impl crate::heap::DirectArenaAccessMut for $name<'_> { #[inline] fn get_direct_mut(self, source: &mut Vec) -> &mut Self::Output { @@ -837,14 +847,16 @@ macro_rules! arena_vec_access { } } - impl AsRef> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsRef> for crate::ecmascript::Agent { #[inline(always)] fn as_ref(&self) -> &Vec<$data> { &self.heap.$member } } - impl AsMut> for crate::ecmascript::execution::Agent { + #[doc(hidden)] + impl AsMut> for crate::ecmascript::Agent { #[inline(always)] fn as_mut(&mut self) -> &mut Vec<$data> { &mut self.heap.$member diff --git a/nova_vm/src/heap/element_array.rs b/nova_vm/src/heap/element_array.rs index 2df234a8f..f9f789552 100644 --- a/nova_vm/src/heap/element_array.rs +++ b/nova_vm/src/heap/element_array.rs @@ -3681,12 +3681,14 @@ impl HeapMarkAndSweep for ElementDescriptor<'static> { } } +#[doc(hidden)] impl AsRef for Agent { fn as_ref(&self) -> &ElementArrays { &self.heap.elements } } +#[doc(hidden)] impl AsMut for Agent { fn as_mut(&mut self) -> &mut ElementArrays { &mut self.heap.elements