docs: add NativeObject design document#5061
Merged
jedel1043 merged 4 commits intoboa-dev:mainfrom Mar 17, 2026
Merged
Conversation
Test262 conformance changes
Tested main commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5061 +/- ##
===========================================
+ Coverage 47.24% 59.11% +11.86%
===========================================
Files 476 563 +87
Lines 46892 62665 +15773
===========================================
+ Hits 22154 37042 +14888
- Misses 24738 25623 +885 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jedel1043
reviewed
Mar 14, 2026
docs/native_object.md
Outdated
Comment on lines
+51
to
+53
| 1. `object.downcast_ref::<T>()` -> Returns `Option<&T>` representing an immutable reference to the native object data if the types match. | ||
| 2. `object.downcast_mut::<T>()` -> Returns `Option<&mut T>` representing a mutable reference to the native object data. | ||
| 3. `object.borrow_mut()` -> Often used when working closely with garbage collected `NativeObject`s that need interior mutability inside contexts. |
Member
There was a problem hiding this comment.
You might also wanna mention downcast, which returns a typed JsObject<T> that can be borrowed later without losing the type information.
jedel1043
added
Waiting On Review
github-actions
bot
added
C-Documentation
github-actions
bot
removed
the
Waiting On Review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #3938
Added a design doc for NativeObject. It covers how Rust types are wrapped using JsData and ObjectData, and how they interact safely with the garbage collector.