docs: explain how Deno.dlopen locates libraries and handles failures#3322
Merged
Conversation
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
1 participant
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.
Feedback on the Deno.dlopen reference asked three questions the docs did not
answer: how Deno locates the library file, whether deno compile can bundle
the .so/.dylib/.dll, and how a failed load is reported. The reference page
itself is generated from upstream JSDoc, so this adds the answers to the FFI
guide it already links to.
The new "Loading libraries" section explains that the path is handed to the
OS dynamic loader, so a relative path resolves against the current working
directory rather than the script, and shows the import.meta.url pattern that
loads a library sitting next to the module from any cwd. It documents
bundling a library into a compiled binary with deno compile --include, and
shows handling load failures with try/catch, noting the distinct messages
for a missing file versus a missing symbol. Every behavior was verified
against a locally built library.
Closes #3146