flutter_rust_bridge 2.0.0-dev.0

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

flutter_rust_bridge

What's new in V2

Please visit this page for information and update guide.

🚧 V2 will still be WIP for few days

Please use the old v1 https://cjycode.com/flutter_rust_bridge/v1/ currently.

The 2.0.0-dev.1 will contain bugs and missing features, because I have to have a real (pre-)release before I can start working on the last part of tests and functionalities. So it is a chicken-and-egg problem ;) But I expect 2.0.0-dev.2 (or -dev.3) to be stable.

🚀 Advantages

• Officially Flutter Favorite: This package is officially Flutter Favorite, and is in the first batch of 7 packages at its rebooting.
• Seamless communication: Call Rust from Dart, as if calling the same language.
  • Arbitrary types: Use arbitrary Rust and Dart types, even if they are not serializable or non-clone.
  • Async & sync x Rust & Dart: Multi modes for various needs - Avoid blocking the main thread, or sync API (e.g. used in Widget.build); Async runtime for IO bound tasks, or thread pools for CPU-heavy computations.
  • Two-way road: Not only can Dart call Rust - Rust can also call Dart.
  • Auto-translatable types: Lots of types can be further translated to Dart native types, e.g. complex enums and structs, zero-copy big arrays, errors (Result), and Streams (iterator).
  • Safety: Focus on your code, and forget memory safety, malloc/free, or undefined behavior completely.
  • Other features: Support whole folders as input, and the output folder will preserve hierarchy. Methods (not only functions).
• Quick setup, but fully customizable: Run a one-liner command, then get a ready-to-use project (or integrate into existing projects). Provide sensible defaults, but everything can be customized.
• Solid CI: We have CI for Valgrind, sanitizers (ASAN/MSAN/LSAN), testing for each platform, benchmarking, codecov, etc.
• Fast: It is only a thin (though feature-rich) wrapper, benchmarked on CI, and even has multiple codecs for best performance under different workloads.
• Lightweight: You are free to use your favorite Flutter and Rust libraries and toolchains (e.g. runner, debugger).
• Cross-platform: Android, iOS, Windows, Linux, MacOS, and Web.
• Pure-Dart compatible: Despite the name, this package is 100% compatible with pure Dart.

Why Flutter + Rust?

Click to expand

Firstly, super briefly introduce each component (you can find much more in a lot of blogs and posts):

• Flutter: Cross-platform, hot-reload, rapid-development, flexible UI toolkit.
  • "The most popular cross-platform mobile SDK" (by StackOverflow [1][2]).
• Rust: Highly efficient and performant, reliable, productive.
  • "The most desired programming language" for 8 years (by StackOverflow and GitHub [1][2]).

Typical scenarios to combine them include:

• UI framework for Rust: When you want a UI framework for your Rust system.
• Use arbitrary Rust libraries in Flutter: When the desired functionality only has a library in Rust, not Dart (Flutter).
• Need high-performance code for Flutter: Rust makes it easy and performant to write multi-thread code, algorithms, data-intensive operations, etc.
• ...

🧭 Show me the code

💡 Documentation

Check out the documentation for quickstart, full guides and more.

✨ Acknowledgments and contributors

Firstly, I want to sincerely thank Dart, Flutter and Rust (alphabetical order). Dart provides a solid foundation for productive UI development, Flutter enables developers to make cross-platform apps with ease, and Rust empowers everyone to build reliable and efficient software. Without the languages and frameworks, this bridge connects absolutely nothing. Besides, I also want to express my thanks for conferring the official Flutter Favorite honor to the package. In addition, I also want to say thanks to the Dart, Flutter and Rust team members as well as community members, who have helped me during the development of flutter_rust_bridge by valuable discussions, insights, and actions.

Secondly, thanks goes to these wonderful contributors (emoji key following all-contributors specification):

fzyzcjy 💻 📖 💡 🤔 🚧	Viet Dinh 💻 ⚠️ 📖	rogurotus 💻 📖	Nicolas Gasull 💻	Joshua Wade 💻	Lattice 0 💻 📖	Unoqwy 💻
Anton Lazarev 💻	sagu 💻 📖	Sebastian Urban 💻	Rom's 💻 📖	老董 💻 📖	Gregory Conrad 📖 💻	huang12zheng 💻 📖
Daniel 💻	Manuel Philipp 💻 📖	SoLongAnd... 💻 📖	hsfzxjy 💻	Cupnfish 💻	alanlzhang 💻 📖	Erikas Taroza 💻
菘菘 💻	SimplyKyle! 💻	Zaitam 💻	Brent Lewis 💻 📖	nitn3lav 💻 📖	Alex Procelewski 📖 💻	Kevin Li 💻 📖
Daniel Porteous (dport) 📖	Andreas Monitzer 💻	Kim Dong-Hyun 💻 📖	NightFeather 💻	九月 💻	Wouter Ensink 📖	Marcel 💻
Aidan 📖	Patrick Auernig 💻	Sai Chaitanya 💻	Xidorn Quan 💻	jsonmona 💻	codercengiz 💻	Michael Bryan 💻
Philip Kannegaard Hayes 💻	bus710 📖	._. 📖	Marc Gutenberger 💻	Andrii Stadnik 💻	Aran Donohue 💻	syndim 💻
Ares Andrew 📖	polypixeldev 📖	CicadaCinema 💻 📖	Fabian Löschner 💻	Vincent Herlemont 💻	Roman Zaynetdinov 📖	raphaelrobert 📖
Mouayad Alhamwi 📖	elliotsayes 📖	muji 📖	thomas725 📖	orange soeur 📖	Alex Gorichev 📖	Sven-Hendrik Haase 📖
Chris Ohk 📖	Vitalii Hurianov 📖	Sam Nystrom 📖	max 📖	Jonathan 📖	Akash Jaiswal 📖	Febrian Setianto 📖
Satvik Pendem 💻	rustui 📖	J 📖	Ikko Ashimine 📖	thesimplekid 📖

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 sealed freezed class in Dart. Support the Option type as nullable types in Dart. Support Vec of Strings type. Support tuple 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. Add support for the Web platform, parallel to the existing mobile/desktop platforms, via WASM and JavaScript as intermediate values. GitHub retry actions. Implement draft of opaque types. Refactor Boxed and Option. Impl list of dates and optionals. Parameter defaults. Refactor CLI. Refactor codegen errors.
• rogurotus: Add Rust opaque types, enabling arbitrary Rust structs to be used as opaque Dart objects by generating wrappers and raw Arc pointers. Also add Dart opaque types, allowing to use any Dart objects in Rust code. Extend SyncReturn for more types. Fix generation bug. Fix SyncReturn. Migrate to dart-sys. Update CI. Fix linters. Fix SyncReturn bug.
• ngasull: Make sync mode support whatever types that classical async mode supports. Bump sdk.
• SecondFlight: Allow structs and enums to be imported from other files within the crate by creating source graph. Auto-create relevant dir. Fix store_dart_post_cobject error with ffigen 6.0.
• lattice0: Implement hierarchy of exceptions. Support methods, such that Rust struct impls can be converted to Dart class methods. StreamSink at any argument.
• 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.
• 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.
• Roms1383: Fix build_runner calling bug. Remove global ffigen dependency. Improve version check. Fix enum name-variant conflicts. Support Chrono date time and UUID types. Migrate to Rust 1.64 workspace. Update and refactor CI. Update header comments. Code cleanup.
• dbsxdbsx: Allow generating multiple Rust and Dart files. Fix lint. Update doc. Add logging.
• GregoryConrad: Add doc to setup frb inside a Dart/Flutter library.
• huang12zheng: Support type aliases and nested ones. Tweak code generation. Fix rust_build_and_test on Mac. Improve CI logic and cache. Remove bridge field in model.
• trobanga: Add support for [T;N] structs. Add usize support. Add a cmd argument. Separate dart tests. Fix fallible list case.
• MnlPhlp: Support macros and will auto expand. Allow mirror types in streams.
• SoLongAndThanksForAllThePizza: Refactor and enhance SyncReturn to support more types. Refactor post-release CI.
• hsfzxjy: Fix SyncReturn use-after-free bug.
• Cupnfish: Support arrays as function parameters. Allow multi mirror.
• alanlzhang: Add generation for Dart metadata. Enhance module parser. Fix enum in struct. Fix linter.
• erikas-taroza: Support list of primitive enums. Make enum camelCase. Warn wrong path. Fix cargo expand.
• SiongSng: Finish implementing exception hierarchy. Fix SyncReturn bug.
• JustSimplyKyle: Also finish implementing exception hierarchy.
• Zaitam: Fix when method return struct. Partial migration to Dart 3.
• coder0xff: Discuss binding unmodified Rust. Refactor SupportedInnerType. Extra codegen tester.
• nitn3lav: Nested structs without Box.
• alexthe2: Add Option Datetime. Add empty structs. Improve doc. Add r#. Fix mirror enum bug.
• AlienKevin: Add flutter example for macOS. Add doc for Android NDK bug.
• banool: Fix pubspec parsing. Fix symbol-stripping doc.
• anlumo: Fix freezed + methods. Non-clone RustOpaque.
• temeddix: Fix broken CI. Custom num workers. Fix MacOS doc steps. Update doc. Make zero-copy defaultable.
• NightFeather0615: Fix Vec bool.
• OfficialBoyfriend: Fix error display.
• w-ensink: Improve doc. Fix CI. Refactor. Add tests.
• smw-wagnerma: Improve Windows encoding handling.
• powpingdone: Document JNI init and libc++_static linking.
• valeth: Rename callFfi's port.
• sccheruku: Prevent double-generating utility.
• upsuper: Refactor delegate-attr.
• jsonmona: Add import.
• codercengiz: Fix mirroring bug.
• Michael-F-Bryan: Detect broken bindings.
• phlip9: Fix no-serde compilation.
• bus710: Add a case in troubleshooting.
• Demezy: Mention troubleshooting.
• gutenfries: Bump proc-macros.
• anstadnik: Check keywords.
• aran: Fix pubspec. Bump version.
• syndim: Add a bracket to box.
• TENX-S: Improve doc. Reproduce a bug.
• polypixeldev: Improve doc.
• CicadaCinema: Bump version. Improve doc.
• w1th0utnam3: Improve message.
• vincent-herlemont: Loosen version.
• zaynetro: Improve doc.
• raphaelrobert: Remove oudated doc.
• DMouayad: Improve doc.
• elliotsayes: Improve doc.
• tmpfs: Improve doc.
• thomas725: Improve doc.
• juzi5201314: Improve doc.
• Voklen: Improve doc.
• svenstaro: Improve doc.
• utilForever: Fix typos.
• not-holar: Fix typos.
• Stonks3141: Fix doc credit.
• vimaxwell: Fix doc link.
• lker-dev: Fix doc link.
• jaiakash: Fix doc link.
• feber: Fix doc link.
• satvikpendem: Little co-work #989.
• rustui: Fix a typo.
• escwxyz: Fix a typo.
• eltociear: Fix a typo.
• thesimplekid: Fix a typo.