/flutter_rust_bridge

High-level memory-safe binding generator for Flutter/Dart <-> Rust

Primary LanguageRustMIT LicenseMIT

flutter_rust_bridge: High-level memory-safe binding generator for Flutter/Dart <-> Rust

Rust Package Flutter Package Stars CI Example Codacy Badge

Logo

Want to combine the best between Flutter, a cross-platform hot-reload rapid-development UI toolkit, and Rust, a language empowering everyone to build reliable and efficient software? Here it comes!

🚀 Advantages

  • Memory-safe: Never need to think about malloc/free.
  • Feature-rich: enums with values, platform-optimized Vec, possibly recursive struct, zero-copy big arrays, Stream (iterator) abstraction, error (Result) handling, cancellable tasks, concurrency control, and more. See full features here.
  • Async programming: Rust code will never block the Flutter. Call Rust naturally from Flutter's main isolate (thread).
  • Lightweight: This is not a huge framework that includes everything, so you are free to use your favorite Flutter and Rust libraries. For example, state-management with Flutter library (e.g. MobX) can be elegant and simple (contrary to implementing in Rust); implementing a photo manipulation algorithm in Rust will be fast and safe (countrary to implementing in Flutter).
  • Cross-platform: Android, iOS, Windows, Linux, MacOS (Web coming soon)
  • Easy to code-review & convince yourself: This package simply simulates how humans write boilerplate code. If you want to convince yourself (or your team) that it is safe, there is not much code to look at. No magic at all! (More about safety concerns.)
  • Fast: It is only a thin (though feature-rich) wrapper, without overhead such as protobuf serialization, thus performant. (More benchmarks later) (Throw away components like thread-pool to make it even faster)
  • Pure-Dart compatible: Despite the name, this package is 100% compatible with pure Dart.

💡 User Guide

Check out the user guide for show-me-the-code, tutorials, features and much more.

📎 P.S. Convenient Flutter tests

If you want to write and debug tests in Flutter conveniently, with action history, time travelling, screenshots, rapid re-execution, video recordings, interactive mode and more, here is my another open-source library: https://github.com/fzyzcjy/flutter_convenient_test.

✨ Contributors

All Contributors

Thanks goes to these wonderful people (emoji key following all-contributors specification):


fzyzcjy
💻 📖 💡 🤔 🚧
Viet Dinh
💻 ⚠️ 📖
Joshua Wade
💻
Marcel
💻
rustui
📖
Michael Bryan
💻
bus710
📖

Sebastian Urban
💻
Daniel
💻
Kevin Li
💻 📖
Patrick Auernig
💻
Anton Lazarev
💻
Unoqwy
💻
Febrian Setianto
📖

syndim
💻
sagu
💻 📖
Ikko Ashimine
📖
alanlzhang
💻 📖
Sai Chaitanya
💻
Ares Andrew
📖
raphaelrobert
📖

thomas725
📖
Daniel Porteous (dport)
📖
Wouter Ensink
📖
老董
💻 📖
Lattice 0
💻 📖

More specifically, thanks for all these contributions:

  • Desdaemon: Support not only simple enums but also enums with fields which gets translated to native enum or freezed class in Dart. Support the Option type as nullable types in Dart. Support Vec of Strings type. Support comments in code. Add marker attributes for future usage. Add Linux and Windows support for with-flutter example, and make CI works for that. Avoid parameter collision. Overhaul the documentation and add several chapters to demonstrate configuring a Flutter+Rust project in all five platforms. Refactor command module. Precompiled binary CI workflow. Fix bugs.
  • SecondFlight: Allow structs and enums to be imported from other files within the crate by creating source graph. Auto-create relavent dir. Fix store_dart_post_cobject error with ffigen 6.0.
  • Unoqwy: Add struct mirrors, such that types in the external crates can be imported and used without redefining and copying.
  • antonok-edm: Avoid converting syn types to strings before parsing to improve code and be more robust.
  • lattice0: Support methods, such that Rust struct impls can be converted to Dart class methods. StreamSink at any argument.
  • sagudev: Make code generator a lib. Add error types. Depend on cbindgen. Fix LLVM paths. Update deps. Fix CI errors.
  • surban: Support unit return type. Skip unresolvable modules. Ignore prefer_const_constructors. Non-final Dart fields.
  • trobanga: Add support for [T;N] structs. Add usize support. Add a cmd argument. Separate dart tests.
  • dbsxdbsx: Allow generating multiple Rust and Dart files.
  • AlienKevin: Add flutter example for macOS. Add doc for Android NDK bug.
  • alanlzhang: Add generation for Dart metadata.
  • efc-mw: Improve Windows encoding handling.
  • valeth: Rename callFfi's port.
  • sccheruku: Prevent double-generating utility.
  • w-ensink: Improve doc. Fix CI. Refactor. Add tests.
  • Michael-F-Bryan: Detect broken bindings.
  • bus710: Add a case in troubleshooting.
  • Syndim: Add a bracket to box.
  • banool: Fix symbol-stripping doc.
  • TENX-S: Improve doc. Reproduce a bug.
  • raphaelrobert: Remove oudated doc.
  • thomas725: Improve doc.
  • feber: Fix doc link.
  • rustui: Fix a typo.
  • eltociear: Fix a typo.