168 releases (stable)

2.6.0	Nov 6, 2024
2.4.0	Sep 13, 2024
2.1.0	Jul 6, 2024
2.0.0-dev.29	Mar 31, 2024
1.10.0	Dec 31, 2021

#17 in #binding-generator

70,334 downloads per month
Used in 2 crates (via flutter_rust_bridge)

MIT license

73KB
155 lines

Rust binding generator, feature-rich, but seamless and simple.

What's new in V2

Tap to expand

From 1.x to 2.0.0-dev.0:
- Rapid setup: Only a one-liner command to integrate into your project.
- Arbitrary types: Use arbitrary Rust and Dart types without manual intervention, even if they are not serializable or non-clone (previously need some manual intervention).
- Async Rust: Support asynchronous Rust (async fn), in addition to sync Rust / async Dart / sync Dart.
- Rust call Dart: Allow Rust to call Dart functions (previously only allow Dart to call Rust).
- Support whole folders as inputs: Previously only support one single file (e.g. api.rs).
- Use libraries/tools in Flutter/Rust: All existing libraries, Flutter debuggers, ... Nothing to stop you from using them.
From 2.0.0-dev.0 to 2.0.0:
- Parsing third-party packages: Scan and use existing Rust packages in Dart (experimental).
- Lifetimes: Support returning types with lifetime specifiers (experimental).
- Traits: Support traits as base classes and trait objects.
- New codec: A new codec, SSE, which is several times faster under some workloads.
- Others (>200 PRs): Auto and manual accessors, object proxies, user-defined serializers, developer experience, deadlock-free auto locking, Rust initializers, included batteries, renaming and ignoring, improving streams, more types, ...

Please visit this page for more information and update guide.

🍀 What's this?

Just write down normal Rust code (even with arbitrary types, closure, &mut, async, traits, etc)
And call it from Flutter, as if Rust code is normal Flutter code
The bridge will generate all glues in between

📚 Quickstart

Create a working Flutter + Rust app and see it live, by running:

cargo install flutter_rust_bridge_codegen && flutter_rust_bridge_codegen create my_app && cd my_app && flutter run

Expand optional steps

(Optional) Edit rust/src/api/simple.rs (e.g. Hello -> Hi), then see the change by:

flutter_rust_bridge_codegen generate && flutter run

For more elaborated quickstart, please visit this page.

🚀 Advantages

1. Officially `Flutter Favorite`

This package is officially Flutter Favorite, and is in the first batch of 7 packages at its rebooting. (another link)

2. Simplicity

(Tap to expand) Rapid setup, Write your code naturally, Use libraries/tools in Flutter/Rust, Battery included

Rapid setup: Only a one-liner command to integrate into your project.
Write your code naturally: Use your intuition and write the code you want. The bridge understands many advanced grammars (see below), allowing seamless calling Rust from Dart.
Use libraries/tools in Flutter/Rust: All existing libraries, Flutter debuggers, ... Nothing to stop you from using them.
Battery included: Even small things like logging and enable backtraces are configured in the starter kit.

3. Powerfulness

(Tap to expand) Arbitrary types, Async & sync, Two-way road, Auto-translatable types, Parsing third-party packages, Auto safety, Customizable & bare-metal mode, Cross-platform, ...

Arbitrary types: Use arbitrary Rust and Dart types without manual intervention, even if they are not serializable or non-clone.
Async & sync x Rust & Dart: Multi modes for various needs - Async Dart to avoid blocking the main thread, sync Dart for places needed (e.g. Widget.build); async Rust for IO bound tasks, 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).
Parsing third-party packages: Scan and use existing Rust packages in Dart (experimental).
Auto safety: Focus on your code, and forget memory safety, malloc/free, or undefined behavior completely.
Customizable & bare-metal mode: Provide sensible defaults, but everything (loader, handler, ...) can be customized. You can even throw all away and only use the bare minimum calling.
Cross-platform: Support Android, iOS, Windows, Linux, MacOS, and Web.
Other features, e.g. support whole folders as input, pure-Dart compatible, instance and static methods, ...

4. Reliability

(Tap to expand) Solid CI, Used by many people, Easy to review, Fast, Hackable, Ask questions

Solid CI: Valgrind & sanitizers (ASAN/MSAN/LSAN) for memory/UB-related bugs, testing per platform per mode, benchmarking, test coverage, post-release, etc, all guaranteed by CI.
Used by many people: See here for an incomplete list.
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 track.
Fast: It is only a thin (though feature-rich) wrapper, benchmarked on CI, and even has multiple codecs for best performance under different workloads.
Hackable: If (for whatever reason) you want to hack the source, there are contributor guides, code is modular, and the execution logic is intuitive.
Ask questions: Feel free to ask questions in the issue tracker, and I usually reply within hours (if not sleeping).

Why Flutter + Rust?

Tap 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, SIMD code, etc.
...

✨ Show me the code

Example 1

Simple Rust...

fn f(a: String, b: Vec<MyEnum>) -> MyStruct { ... }

...called from Dart, without manual intervention.

print(f(a: 'Hello', b: [MyEnum.c('Tom')]));

Example 2

Suppose we implement a word dictionary in Rust:

// ↱ Arbitrarily fancy Rust types
pub struct WordDict { .. }

// ↱ Support functions & methods
impl WordDict {
    //          ↱ Can call Dart back                 ↱ Translate errors
    pub fn open(chooser: impl Fn(String) -> bool) -> Result<WordDict> { .. }

    // ↱ Support async & sync Dart; property getter
    #[frb(sync, getter)]
    //          ↱ Support T/&T/&mut T
    pub fn size(&self) -> u32 { .. }

    //  ↱ Allow async & sync                    ↱ Support stream (iterator)
    pub async fn search(&self, keyword: String, sink: StreamSink<String>) { .. }
}

Still seamlessly call in Dart:

final dict = await WordDict.open((situation) => true);
print(dict.size);
await for (final value in dict.search('something')) { print(value); }

There are still many features not covered here, such as parsing third party packages, lifetimes, traits, auto accessors, proxies, etc.

💡 Documentation

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

📎 P.S. Achieve ~60 FPS, no matter how janky the Flutter app was due to build/layout

Here is my another open-source library :) https://github.com/fzyzcjy/flutter_smooth.

✨ 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} 💻 📖	_derdilla 💻 📖	_nitn3lav 💻 📖	_Henry 💻
_{Kevin Li} 💻 📖	_{Alex Procelewski} 📖 💻	_Larpoux 💻	_{Patrick Mukherjee} 💻	_{Daniel Porteous (dport)} 📖	_{Alex Li} 💻	_{Andreas Monitzer} 💻
_{Kim Dong-Hyun} 💻 📖	_NightFeather 💻	_{Alex Ballmer} 💻	_alexlapa 💻	_九月 💻	_wxitcode 📖	_{Tien Do Nam} 💻
_Arjen 💻	_{Johannes Löthberg} 💻	_Markus 💻	_Krysl 💻	_{Frederick Vollbrecht} 💻	_{Wouter Ensink} 📖	_Marcel 💻
_Aidan 📖	_{Debanjan Basu} 📖	_{Patrick Auernig} 💻	_{Sai Chaitanya} 💻	_{Xidorn Quan} 💻	_jsonmona 💻	_mtz 💻
_codercengiz 💻	_{Aran Donohue} 💻	_{Michael Bryan} 💻	_{Philip Kannegaard Hayes} 💻	_SilverMira 💻	_{Sander in 't Hout} 💻	_{Haled Odat} 💻
_王宇逸 💻	_bus710 📖	_{._.} 📖	_{Marc Gutenberger} 💻	_{Andrii Stadnik} 💻	_syndim 💻	_{Dirk Van Haerenborgh} 💻
_{Rhian Moraes} 📖	_{Ares Andrew} 📖	_polypixeldev 📖	_CicadaCinema 💻 📖	_CosmicHorror 💻	_{Akash Gurava} 💻	_{Fabian Löschner} 💻
_{Vincent Herlemont} 💻	_canxin 💻	_pixelshot91 📖	_TrackerSB 💻	_{Slavik Bubnov} 📖	_Dampfwalze 📖	_{Samuel Cavalcanti} 📖
_{Roman Zaynetdinov} 📖	_{raphaelrobert} 📖	_{Mouayad Alhamwi} 📖	_elliotsayes 📖	_muji 📖	_thomas725 📖	_{orange soeur} 📖
_{Alex Gorichev} 📖	_{Sven-Hendrik Haase} 📖	_{Chris Ohk} 📖	_{Vitalii Hurianov} 📖	_{Sam Nystrom} 📖	_{mattiasgronlund} 💻	_{Antonio D'souza} 📖
_max 📖	_Jonathan 📖	_{Akash Jaiswal} 📖	_{Febrian Setianto} 📖	_{Satvik Pendem} 💻	_{Damien Wise} 📖	_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. Refactor for performance.
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. Loosen config. Prefix methods.
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. Fix test compile. Fix Result + RustAutoOpaque.
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 and fix module parser. Fix enum in struct. Fix linter. Improve hints.
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. Allow ignore function.
Zaitam: Fix when method return struct. Partial migration to Dart 3.
coder0xff: Discuss binding unmodified Rust. Refactor SupportedInnerType. Extra codegen tester.
NobodyForNothing: Support impl-for partially.
nitn3lav: Nested structs without Box.
mcmah309: Add cli plugin scaffold generation.
AlienKevin: Add flutter example for macOS. Add doc for Android NDK bug. Improve migration doc.
alexthe2: Add Option Datetime. Add empty structs. Improve doc. Add r#. Fix mirror enum bug.
Larpoux: Fix async generation. Update web-audio-api binding.
patmuk: Set MSRV. Fail fast. Improve message. Support relative config. Improve multiple docs. Fix warning.
banool: Fix pubspec parsing. Fix symbol-stripping doc.
AlexV525: Add Dart fix. Fix folder.
anlumo: Fix freezed + methods. Non-clone RustOpaque. Update syn.
temeddix: Fix broken CI. Custom num workers. Fix MacOS doc steps. Update doc. Make zero-copy defaultable.
NightFeather0615: Fix Vec bool.
fmeef: Add cargo feature flag.
alexlapa: Fix DartOpaque.
OfficialBoyfriend: Fix error display.
wxitcode: Add org option. Support MacOS log. Fix a typo.
Tienisto: Add mock init.
atezet: Upgrade dependencies. Follow rustfmt.
kyrias: Use portable atomic.
Markus43: Fix folder removal.
Krysl: Add preamble.
Vollbrecht: Warn absolute path.
w-ensink: Improve doc. Fix CI. Refactor. Add tests.
smw-wagnerma: Improve Windows encoding handling.
powpingdone: Document JNI init and libc++_static linking.
debanjanbasu: Document alternative NDK init.
valeth: Rename callFfi's port.
sccheruku: Prevent double-generating utility.
upsuper: Refactor delegate-attr.
jsonmona: Add import.
MateusHBR: Add pub get.
codercengiz: Fix mirroring bug.
aran: Fix map + mirror. Fix pubspec. Upgrde ffigen. Replace to js_interop. Bump version. Fix typo.
Michael-F-Bryan: Detect broken bindings.
phlip9: Fix no-serde compilation.
SilverMira: Fix StreamSink.
h3x4d3c1m4l: Fix when outside folder.
HalidOdat: Improve config method. Hint build.rs.
Berrysoft: Fix missing symbols.
bus710: Add a case in troubleshooting.
Demezy: Mention troubleshooting.
gutenfries: Bump proc-macros.
anstadnik: Check keywords.
syndim: Add a bracket to box.
vhdirk: Support dashed crate.
rhian-cs: Add Cargo workspace doc.
TENX-S: Improve doc. Reproduce a bug.
polypixeldev: Improve doc.
CicadaCinema: Bump version. Improve doc.
CosmicHorrorDev: Change deps.
akashgurava: Partial fix.
w1th0utnam3: Improve message.
vincent-herlemont: Loosen version.
canxin121: Fix permission.
pixelshot91: Update cargokit. Fix doc link.
TrackerSB: Bump allo-isolate.
bubnov: Improve doc.
Dampfwalze: Improve doc.
samuel-cavalcanti: Improve doc.
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.
mattiasgronlund: Bump version.
adsouza: Fix doc grammar.
vimaxwell: Fix doc link.
lker-dev: Fix doc link.
jaiakash: Fix doc link.
feber: Fix doc link.
satvikpendem: Little co-work #989.
damywise: Fix a typo.
rustui: Fix a typo.
escwxyz: Fix a typo.
eltociear: Fix a typo.
thesimplekid: Fix a typo.

Dependencies

~0.5–1MB
~25K SLoC