Skip to content
Aritra Karak edited this page Oct 14, 2023 · 2 revisions

Welcome to the Hyperimport wiki !

Here you will find a comprehensive documentation about this project.

How does this project even work ?

  • The imported source file (rust, zig etc.) is first read using Plugin API.
  • The rust, zig etc. compiler is then invoked to compile the source file into a shared library on the fly.
  • The unix command nm is executed on the compiled library to extract exported symbols.
  • The shared library is then dlopened using FFI API and the function symbols are exported.
  • The exported function symbols are wrapped into an ES Module using Plugin API ready to be imported by the user.

How to get started ?

Check out Importing a rust file for a step by step guide on setting up a basic hyperimport project.

Browse the other pages of this wiki for more detailed documentations about other things.