Dart-sys
Rust bindings to the Dart native extensions api
Getting Started 🚀
Prerequisites 🔧
You will need the following tools available on your system:
Installing 📦
Run the following Cargo command in your project directory:
Or add the following line to your Cargo.toml:
= "0.0.2"
Source code releases for each SemVer tag are also available on the GitHub releases page.
Usage 💻
Examples 📚
An extremely straightforward example of using dart-sys
would be like such:
use ;
/// Adds two integers together.
pub extern "C"
/// Multiplies two integers together.
pub extern "C"
import 'dart:ffi';
// open and link to the native library
final DynamicLibrary nativeLib = DynamicLibrary.open('libdart_sys_example_extension.so');
// lookup the sum function in the native library
final int Function(int, int) sum = nativeLib
.lookup<NativeFunction<Int32 Function(Int32, Int32)>>('dart_sys_example_extension_sum')
.asFunction();
// lookup the product function in the native library
final int Function(int, int) product = nativeLib
.lookup<NativeFunction<Int32 Function(Int32, Int32)>>('dart_sys_example_extension_product')
.asFunction();
void main() {
print(sum(1, 2)); // 3
print(product(1, 2)); // 2
}
While this example is certainly possible, you are not likely to ever use Dart-sys for this purpose. See the examples directory for more in-depth examples of how to use Dart-sys. All of the examples are tested using GitHub Actions and documented verbosely.
Built With 🛠️
- Rust - A systems programming language that runs blazingly fast, prevents segfaults, and guarantees thread safety.
- Dart - A client-optimized language for fast apps on any platform.
- Dart Native Extensions - A mechanism for writing native code in C/C++ and calling it from Dart.
- bindgen - A Rust library for generating bindings to C and C++ APIs.
Contributing ✏️
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests. If you have any questions, please open an issue, or contact admin gutenfries@gmail.com directly.
Versioning 🪧
We use SemVer for versioning. For the versions available, see the tags on this repository.
License 📜
Dart-sys is open-sourced and released under the terms and conditions of the following three licenses: