Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dart-sys/dart-sys
Rust bindings to the dart native extensions api
https://github.com/dart-sys/dart-sys
dart dart-ffi dart-lang dart-rust ffi flutter flutter-dart flutter-rust flutter-rust-bridge rust rust-dart rust-lang
Last synced: 27 days ago
JSON representation
Rust bindings to the dart native extensions api
- Host: GitHub
- URL: https://github.com/dart-sys/dart-sys
- Owner: dart-sys
- License: other
- Created: 2019-09-29T19:45:56.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T02:37:52.000Z (8 months ago)
- Last Synced: 2024-09-29T16:05:03.361Z (about 1 month ago)
- Topics: dart, dart-ffi, dart-lang, dart-rust, ffi, flutter, flutter-dart, flutter-rust, flutter-rust-bridge, rust, rust-dart, rust-lang
- Language: Rust
- Homepage: https://crates.io/crates/dart-sys
- Size: 30.8 MB
- Stars: 40
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE-2.0.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Dart-Sys
# Dart-sys
[](https://github.com/dart-sys/dart-sys/stargazers)
[](https://github.com/dart-sys/dart-sys/network/members)
[](https://crates.io/crates/dart-sys)
[](https://opensource.org/licenses/MIT)
[](https://opensource.org/licenses/Apache-2.0)
[](https://docs.rs/dart-sys)
[](https://github.com/dart-sys/dart-sys/actions/workflows/ci.yml)
> _Rust bindings to the [Dart ffi api](https://dart.dev/guides/libraries/c-interop)_
## Prerequisites 🔧
You will need the following tools available on your system:
- [Dart](https://dart.dev/get-dart) version 2.12 or higher
- [Rust](https://www.rust-lang.org/tools/install) version 1.51 or higher
- [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
- [Git](https://git-scm.com/downloads)
### 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.1.5"
```
## Usage 💻
### Examples 📚
An extremely straightforward example of using `dart-sys` would be like such:
```rust
use dart_sys::{Dart_Handle, Dart_NewIntegerFromI64};
#[no_mangle]
/// Adds two integers together.
pub extern "C" fn dart_sys_example_extension_sum(
a: Dart_Handle,
b: Dart_Handle,
) -> Dart_Handle {
let a = unsafe { Dart_NewIntegerFromI64(a) };
let b = unsafe { Dart_NewIntegerFromI64(b) };
a + b
}
#[no_mangle]
/// Multiplies two integers together.
pub extern "C" fn dart_sys_example_extension_product(
a: Dart_Handle,
b: Dart_Handle,
) -> Dart_Handle {
let a = unsafe { Dart_NewIntegerFromI64(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('libdart_sys_example_extension.so');
// lookup the sum function in the native library
final int Function(int, int) sum = nativeLib
.lookup>('dart_sys_example_extension_sum')
.asFunction();
// lookup the product function in the native library
final int Function(int, int) product = nativeLib
.lookup>('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](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](https://www.rust-lang.org/) - A systems programming language that runs
blazingly fast, prevents segfaults, and guarantees thread safety.
- [Dart](https://dart.dev/) - A client-optimized language for fast apps on any platform.
- [Dart Native Extensions](https://dart.dev/server/c-interop-native-extensions) - A mechanism
for writing native code in C/C++ and calling it from Dart.
- [bindgen](https://crates.io/crates/bindgen) - A Rust library for generating
bindings to C and C++ APIs.
## Contributing ✏️
Please read [CONTRIBUTING.md](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 directly.
## Versioning 🪧
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/dart-sys/dart-sys/tags).
## License 📜
Dart-sys is open-sourced and released under the terms and conditions of one or both of the following licenses:
- [MIT License](LICENSE-MIT.md)
- [Apache License (Version 2.0)](LICENSE-APACHE-2.0.md)
## Acknowledgments 🙏
- [README starter](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) by [@PurpleBooth](https://gist.github.com/PurpleBooth)