chore(napi): expose functions which turn raw pointer into External#2449
Merged
Brooooooklyn merged 2 commits intonapi-rs:mainfrom Feb 3, 2025
Merged
chore(napi): expose functions which turn raw pointer into External#2449Brooooooklyn merged 2 commits intonapi-rs:mainfrom
Brooooooklyn merged 2 commits intonapi-rs:mainfrom
Conversation
Brooooooklyn
pushed a commit
that referenced
this pull request
Feb 3, 2025
…2449) * Expose functions which turn raw pointer into External * Add safety documentation
Member
1 task
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
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.
Hi, we recently shipped a native bundler plugin API for Bun, with a Rust crate which exposes a convenient way to create native bundler plugins for Bun (here).
Native bundler plugins in Bun are NAPI modules which expose an additional symbol to a function which implements the bundler plugin code.
To make this nicer to write in Rust, we want to allow users to integrate it with
napi-rs.We want to allow users to use
napi-rsExternaltype when writing native bundler plugins. Native bundler plugins can carry around the raw pointer to the napi external.However,
napi-rsdoes not mark the fields ofExternalaspubor export anyway to go from*mut c_void -> External<T>.Currently in
bun-native-plugin-rswe do something like this to do that:This is obviously bad as
napi-rscould changeTaggedObject.So this PR exports function which exposes some logic to go from
*mut c_void -> Option<&T>, where T is the inner type of theExternal<T>.