todo

Todo App

Rust integrated Dart Flutter Project

Tutorial

A tutorial on how to build this app will be provided shortly on the rid homepage.

Getting Started

Please see Caveats first.

Use the below scripts to get the app ready to run with Flutter.

0. Make sure you have the dependencies

# Install the nightly to use some needed features
rustup toolchain install nightly
# Switch to the nightly 
rustup default nightly

On linux, you also need

sudo apt-get install libclang-dev jq

for flutter's ffigen.

1. Generate Glue Code

Before generating the glue code for the first time, you need to run flutter pub get on the plugin folder

cd plugin
flutter pub get

./sh/bindgen

2. Build For Desired Target/Device

Run any of the below three to build the binary for the specific device and have it placed into the devices specific plugin folder.

For macos:

./sh/macos

For linux:

./sh/linux

3. Run with Flutter

Run on the device.

flutter run -d macos

flutter run -d linux

For linux, you should pass the path to libtodo.so:

On ~/rid-examples/flutter/todo$:

LD_LIBRARY_PATH=$PWD/plugin/linux flutter run -d linux

4. Develop

Run step 1 whenever a function exposed to Flutter changes.

Run step 2 whenever any of your Rust code changes.

Note that to apply changes from Rust you need to restart the app to reload the compiled binary. A hot restart/reload does not achieve this.

Folder Structure

├── android
├── ios
├── macos
├── lib
├── plugin
│   ├── android
│   ├── ios
│   ├── macos
│   └── lib
└── src

./plugin

Provides connection from Flutter to Rust.

Rust binaries are placed into the respective plugin folders ./ios, ./macos, ./android when they are built.

Generated Dart glue code is placed inside ./plugin/lib/generated while ./plugin/lib/plugin.dart just exposes the API to the app.

./src

Contains the starter Rust code inside ./src/lib.rs. Keep developing the Rust part of your app here.

./lib

Contains the starter Flutter app inside ./lib/main.dart.

./sh

Provides scripts to run build and code generation tasks. In the future a tool will provide the functionality currently provided by these scripts.

• bindgen generates the binding.h header file for the extern Rust functions found inside ./src. These are then placed inside the ./plugin device folders were needed as well as ./plugin/lib/generated/binding.h where they are used to generate Dart glue code
• ffigen generates Dart glue code inside ./plugin/lib/generated/ffigen_binding.dart using ./plugin/lib/generated/binding.h as input
• ./android builds the Rust binary to run on Android devices/emulators and places it inside ./plugin/lib/android
• ./ios builds the Rust binary to run on IOS devices/emulators and places it inside ./plugin/lib/ios
• ./macos builds the Rust binary to run on MacOs directly and places it inside ./plugin/lib/macos, this is the same format as running cargo build on your Mac

Caveats

At this point Rid hasn't been published, therefore the build step cannot be performed and this example only serves to demonstrate what is possible once it is published and open sourced.

For more information please see Is Rid Open Sourced?