Dart-sys brand header

Dart-sys

Rust bindings to the Dart native extensions api

Prerequisites 🔧

You will need the following tools available on your system:

Dart version 2.12 or higher
Rust version 1.51 or higher
Cargo
Git

Unix/Linux 🐧

No additional requirements :)

MacOS 🍎

No additional requirements :)

Windows 🪟

On Windows platforms, dynamic libraries are linked against the executable, not into the executable as is the case o Unix platforms.

⚠️ Important ⚠️

This means that (on Windows) you will Need to have the Dart SDK installed and available on your system path to be able to compile Dart-sys.

Installing 📦

Run the following Cargo command in your project directory:

bash cargo add dart-sys

Or add the following line to your Cargo.toml:

toml dart-sys = "4.0.1"

Usage 💻

Examples 📚

An extremely straightforward example of using dart-sys would be like such:

```rust use dartsys::{DartHandle, Dart_NewIntegerFromI64};

[no_mangle]

/// Adds two integers together. pub extern "C" fn dartsysexampleextensionsum( a: DartHandle, b: DartHandle, ) -> DartHandle { let a = unsafe { DartNewIntegerFromI64(a) }; let b = unsafe { Dart_NewIntegerFromI64(b) }; a + b }

[no_mangle]

/// Multiplies two integers together. pub extern "C" fn dartsysexampleextensionproduct( a: DartHandle, b: DartHandle, ) -> DartHandle { let a = unsafe { DartNewIntegerFromI64(a) }; let b = unsafe { Dart_NewIntegerFromI64(b) }; a * b } ```

```dart import 'dart:ffi';

// open and link to the native library final DynamicLibrary nativeLib = DynamicLibrary.open('libdartsysexample_extension.so');

// lookup the sum function in the native library final int Function(int, int) sum = nativeLib .lookupsysexampleextensionsum') .asFunction();

// lookup the product function in the native library final int Function(int, int) product = nativeLib .lookupsysexampleextensionproduct') .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 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:

Acknowledgments 🙏

README starter by @PurpleBooth