Skip to content

Commit e0e12ec

Browse files
aapoalasaapoalas
authored
chore(docs): Hide internal AsRef and AsMut docs (#974)
1 parent a5d0193 commit e0e12ec

9 files changed

Lines changed: 40 additions & 8 deletions

File tree

‎nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_group_record.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,14 @@ impl<'a> PromiseGroup<'a> {
233233
}
234234
}
235235

236+
#[doc(hidden)]
236237
impl AsRef<[PromiseGroupRecord<'static>]> for Agent {
237238
fn as_ref(&self) -> &[PromiseGroupRecord<'static>] {
238239
&self.heap.promise_group_records
239240
}
240241
}
241242

243+
#[doc(hidden)]
242244
impl AsMut<[PromiseGroupRecord<'static>]> for Agent {
243245
fn as_mut(&mut self) -> &mut [PromiseGroupRecord<'static>] {
244246
&mut self.heap.promise_group_records

‎nova_vm/src/ecmascript/builtins/ordinary/shape.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,13 +1093,15 @@ impl<'a> DirectArenaAccessMut for ObjectShape<'a> {
10931093
}
10941094
}
10951095

1096+
#[doc(hidden)]
10961097
impl AsRef<Vec<ObjectShapeRecord<'static>>> for Agent {
10971098
#[inline(always)]
10981099
fn as_ref(&self) -> &Vec<ObjectShapeRecord<'static>> {
10991100
&self.heap.object_shapes
11001101
}
11011102
}
11021103

1104+
#[doc(hidden)]
11031105
impl AsMut<Vec<ObjectShapeRecord<'static>>> for Agent {
11041106
#[inline(always)]
11051107
fn as_mut(&mut self) -> &mut Vec<ObjectShapeRecord<'static>> {
@@ -1283,12 +1285,14 @@ impl HeapMarkAndSweep for PrototypeShapeTable {
12831285
}
12841286
}
12851287

1288+
#[doc(hidden)]
12861289
impl AsRef<[ObjectShapeTransitionMap<'static>]> for Agent {
12871290
fn as_ref(&self) -> &[ObjectShapeTransitionMap<'static>] {
12881291
&self.heap.object_shape_transitions
12891292
}
12901293
}
12911294

1295+
#[doc(hidden)]
12921296
impl AsMut<[ObjectShapeTransitionMap<'static>]> for Agent {
12931297
fn as_mut(&mut self) -> &mut [ObjectShapeTransitionMap<'static>] {
12941298
&mut self.heap.object_shape_transitions

‎nova_vm/src/ecmascript/builtins/typed_array/normal_typed_array.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2297,12 +2297,14 @@ impl<'a, T: Viewable> DirectArenaAccessMut for GenericTypedArray<'a, T> {
22972297
}
22982298
}
22992299
}
2300+
#[doc(hidden)]
23002301
impl AsRef<Vec<TypedArrayRecord<'static>>> for Agent {
23012302
#[inline(always)]
23022303
fn as_ref(&self) -> &Vec<TypedArrayRecord<'static>> {
23032304
&self.heap.typed_arrays
23042305
}
23052306
}
2307+
#[doc(hidden)]
23062308
impl AsMut<Vec<TypedArrayRecord<'static>>> for Agent {
23072309
#[inline(always)]
23082310
fn as_mut(&mut self) -> &mut Vec<TypedArrayRecord<'static>> {

‎nova_vm/src/ecmascript/builtins/typed_array/shared_typed_array.rs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2321,13 +2321,15 @@ impl<'a, T: Viewable> DirectArenaAccessMut for GenericSharedTypedArray<'a, T> {
23212321
}
23222322
}
23232323
}
2324-
impl AsRef<Vec<SharedTypedArrayRecord<'static>>> for crate::ecmascript::execution::Agent {
2324+
#[doc(hidden)]
2325+
impl AsRef<Vec<SharedTypedArrayRecord<'static>>> for crate::ecmascript::Agent {
23252326
#[inline(always)]
23262327
fn as_ref(&self) -> &Vec<SharedTypedArrayRecord<'static>> {
23272328
&self.heap.shared_typed_arrays
23282329
}
23292330
}
2330-
impl AsMut<Vec<SharedTypedArrayRecord<'static>>> for crate::ecmascript::execution::Agent {
2331+
#[doc(hidden)]
2332+
impl AsMut<Vec<SharedTypedArrayRecord<'static>>> for crate::ecmascript::Agent {
23312333
#[inline(always)]
23322334
fn as_mut(&mut self) -> &mut Vec<SharedTypedArrayRecord<'static>> {
23332335
&mut self.heap.shared_typed_arrays

‎nova_vm/src/ecmascript/execution/environments.rs‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,16 @@ macro_rules! create_environment_index {
109109
}
110110
}
111111

112-
impl AsRef<Vec<$record>> for crate::ecmascript::execution::Agent {
112+
#[doc(hidden)]
113+
impl AsRef<Vec<$record>> for crate::ecmascript::Agent {
113114
#[inline(always)]
114115
fn as_ref(&self) -> &Vec<$record> {
115116
&self.heap.environments.$entry
116117
}
117118
}
118119

119-
impl AsMut<Vec<$record>> for crate::ecmascript::execution::Agent {
120+
#[doc(hidden)]
121+
impl AsMut<Vec<$record>> for crate::ecmascript::Agent {
120122
#[inline(always)]
121123
fn as_mut(&mut self) -> &mut Vec<$record> {
122124
&mut self.heap.environments.$entry
@@ -1155,12 +1157,14 @@ impl AsMut<Environments> for Environments {
11551157
}
11561158
}
11571159

1160+
#[doc(hidden)]
11581161
impl AsRef<Environments> for Agent {
11591162
fn as_ref(&self) -> &Environments {
11601163
&self.heap.environments
11611164
}
11621165
}
11631166

1167+
#[doc(hidden)]
11641168
impl AsMut<Environments> for Agent {
11651169
fn as_mut(&mut self) -> &mut Environments {
11661170
&mut self.heap.environments

‎nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,14 @@ impl<'a> ModuleRequestRecord<'a> {
6262
}
6363
}
6464

65+
#[doc(hidden)]
6566
impl AsRef<[ModuleRequestRecord<'static>]> for Agent {
6667
fn as_ref(&self) -> &[ModuleRequestRecord<'static>] {
6768
&self.heap.module_request_records
6869
}
6970
}
7071

72+
#[doc(hidden)]
7173
impl AsMut<[ModuleRequestRecord<'static>]> for Agent {
7274
fn as_mut(&mut self) -> &mut [ModuleRequestRecord<'static>] {
7375
&mut self.heap.module_request_records

‎nova_vm/src/ecmascript/scripts_and_modules/module/module_semantics/source_text_module_records.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2247,12 +2247,14 @@ impl AsMut<SourceTextModuleHeap> for SourceTextModuleHeap {
22472247
}
22482248
}
22492249

2250+
#[doc(hidden)]
22502251
impl AsRef<SourceTextModuleHeap> for Agent {
22512252
fn as_ref(&self) -> &SourceTextModuleHeap {
22522253
&self.heap.source_text_module_records
22532254
}
22542255
}
22552256

2257+
#[doc(hidden)]
22562258
impl AsMut<SourceTextModuleHeap> for Agent {
22572259
fn as_mut(&mut self) -> &mut SourceTextModuleHeap {
22582260
&mut self.heap.source_text_module_records

‎nova_vm/src/heap.rs‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -720,6 +720,7 @@ fn init_heap() {
720720

721721
macro_rules! arena_vec_access {
722722
(soa: $name: ident, $lt: lifetime, $data: ident, $member: ident, $output_ref: ident, $output_mut: ident) => {
723+
#[doc(hidden)]
723724
impl<$lt> crate::heap::DirectArenaAccessSoA for $name<$lt> {
724725
type Data = $data<'static>;
725726

@@ -734,6 +735,7 @@ macro_rules! arena_vec_access {
734735
}
735736
}
736737

738+
#[doc(hidden)]
737739
impl<$lt> crate::heap::DirectArenaAccessSoAMut for $name<$lt> {
738740
#[inline]
739741
fn get_direct_mut<'agent>(
@@ -760,21 +762,24 @@ macro_rules! arena_vec_access {
760762
}
761763
}
762764

763-
impl AsRef<soavec::SoAVec<$data<'static>>> for crate::ecmascript::execution::Agent {
765+
#[doc(hidden)]
766+
impl AsRef<soavec::SoAVec<$data<'static>>> for crate::ecmascript::Agent {
764767
#[inline(always)]
765768
fn as_ref(&self) -> &soavec::SoAVec<$data<'static>> {
766769
&self.heap.$member
767770
}
768771
}
769772

770-
impl AsMut<soavec::SoAVec<$data<'static>>> for crate::ecmascript::execution::Agent {
773+
#[doc(hidden)]
774+
impl AsMut<soavec::SoAVec<$data<'static>>> for crate::ecmascript::Agent {
771775
#[inline(always)]
772776
fn as_mut(&mut self) -> &mut soavec::SoAVec<$data<'static>> {
773777
&mut self.heap.$member
774778
}
775779
}
776780
};
777781
($name: ident, $lt: lifetime, $data: ident, $member: ident) => {
782+
#[doc(hidden)]
778783
impl<$lt> crate::heap::DirectArenaAccess for $name<$lt> {
779784
type Data = $data<'static>;
780785
type Output = $data<$lt>;
@@ -787,6 +792,7 @@ macro_rules! arena_vec_access {
787792
}
788793
}
789794

795+
#[doc(hidden)]
790796
impl<$lt> crate::heap::DirectArenaAccessMut for $name<$lt> {
791797
#[inline]
792798
fn get_direct_mut(self, source: &mut Vec<Self::Data>) -> &mut Self::Output {
@@ -801,13 +807,15 @@ macro_rules! arena_vec_access {
801807
}
802808
}
803809

810+
#[doc(hidden)]
804811
impl AsRef<Vec<$data<'static>>> for crate::ecmascript::Agent {
805812
#[inline(always)]
806813
fn as_ref(&self) -> &Vec<$data<'static>> {
807814
&self.heap.$member
808815
}
809816
}
810817

818+
#[doc(hidden)]
811819
impl AsMut<Vec<$data<'static>>> for crate::ecmascript::Agent {
812820
#[inline(always)]
813821
fn as_mut(&mut self) -> &mut Vec<$data<'static>> {
@@ -816,6 +824,7 @@ macro_rules! arena_vec_access {
816824
}
817825
};
818826
($name: ident, $data: ty, $member: ident, $output: ty) => {
827+
#[doc(hidden)]
819828
impl crate::heap::DirectArenaAccess for $name<'_> {
820829
type Data = $data;
821830
type Output = $output;
@@ -828,6 +837,7 @@ macro_rules! arena_vec_access {
828837
}
829838
}
830839

840+
#[doc(hidden)]
831841
impl crate::heap::DirectArenaAccessMut for $name<'_> {
832842
#[inline]
833843
fn get_direct_mut(self, source: &mut Vec<Self::Data>) -> &mut Self::Output {
@@ -837,14 +847,16 @@ macro_rules! arena_vec_access {
837847
}
838848
}
839849

840-
impl AsRef<Vec<$data>> for crate::ecmascript::execution::Agent {
850+
#[doc(hidden)]
851+
impl AsRef<Vec<$data>> for crate::ecmascript::Agent {
841852
#[inline(always)]
842853
fn as_ref(&self) -> &Vec<$data> {
843854
&self.heap.$member
844855
}
845856
}
846857

847-
impl AsMut<Vec<$data>> for crate::ecmascript::execution::Agent {
858+
#[doc(hidden)]
859+
impl AsMut<Vec<$data>> for crate::ecmascript::Agent {
848860
#[inline(always)]
849861
fn as_mut(&mut self) -> &mut Vec<$data> {
850862
&mut self.heap.$member

‎nova_vm/src/heap/element_array.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3681,12 +3681,14 @@ impl HeapMarkAndSweep for ElementDescriptor<'static> {
36813681
}
36823682
}
36833683

3684+
#[doc(hidden)]
36843685
impl AsRef<ElementArrays> for Agent {
36853686
fn as_ref(&self) -> &ElementArrays {
36863687
&self.heap.elements
36873688
}
36883689
}
36893690

3691+
#[doc(hidden)]
36903692
impl AsMut<ElementArrays> for Agent {
36913693
fn as_mut(&mut self) -> &mut ElementArrays {
36923694
&mut self.heap.elements

0 commit comments

Comments
 (0)