Summary

Introduction

Part I: Core

• 🧭 Quickstart
• 📚 Tutorial: A Flutter+Rust app
  • Android setup
    • Alternative NDK setup
• 🎼 Features
  • Language translations
    • Simple correspondence
    • Vec and array
    • Struct
    • Enum
    • Tuples
    • External types
    • Option
    • Methods
    • Return types
    • Dynamic
    • Arbitrary Rust types (opaque)
    • Arbitrary Dart types (opaque)
    • Type alias
    • Result / Exceptions
    • Parameter defaults
  • Zero copy
  • Stream / Iterator
  • Async in Dart
  • Sync in Dart
  • Concurrency
  • Handler
  • Initialization
  • Async in Rust
  • Multiple files
  • Run in build.rs
  • Cancellable tasks
  • Object pools
  • WASM
  • Miscellaneous
  • Logging
  • Stack Traces
  • Worker pool
  • Expanding macros

Part II: User Guide

• Create new projects from a template
  • Creating a new project
    • Android setup
    • iOS setup
    • Web setup
    • Windows and Linux
    • Other platforms
  • Template tour
    • native/src/api.rs
    • android/app/build.gradle
    • native/native.xcodeproj
    • justfile
    • rust.cmake
  • Generating code
    • Installing codegen
    • Adding new code
    • Using build_runner
    • Wrapping up
• Integrating with existing projects
  • Creating a new crate
  • Installing dependencies
  • Integrating with Android
    • Hooking onto tasks
    • CMake with Gradle
  • Integrating with iOS/MacOS
    • Creating the Rust project
    • Linking the project
    • Generating bindings
    • Using dummy headers
  • Integrating with Windows and Linux
  • Integrating with Web
  • Using the dynamic library
  • Wrapping up
• Creating a Dart/Flutter library
  • Overview
    • Setup
    • Monorepo with Melos
  • Creating the libraries
    • Dart-only base
    • Flutter wrapper
  • Platform specific setup
    • Windows & Linux
    • iOS & macOS
    • Android
  • Continuous Integration & Deployment (CI/CD)

Part III: Contributor Guide

• Overview
• Overall design
• Submodule implementations
  • Rust opaque type safety
  • Dart opaque type safety
• Appendix

Part IV: More Doc

• Unit testing in Flutter
• Tutorial: Pure Dart
• Safety concerns
• Troubleshooting
• Command line arguments
• Set up Flutter/Dart+Rust support from scratch
• Building a WASM binary manually
• Limitations of WASM
• Articles
  • Async in Rust
  • Generate multiple files