jffi-0.3.8 is not a library.

JFFI

A cross-platform framework for building native applications with Rust business logic and platform-native UIs.

Philosophy

Write your business logic once in Rust. Build native UIs for each platform.

Write business logic once in Rust
Use native UI frameworks (SwiftUI, Jetpack Compose, WinUI, etc.)
Get truly native performance and platform feel
Maintain type safety end-to-end via UniFFI

Quick Start

Installation

# Install JFFI CLI
cargo install --path cli

Create Your First App

# Create a new app with platform support
jffi new my-app --platforms ios,macos,android,linux,windows

# Navigate and run
cd my-app
jffi run --platform ios      # iOS Simulator
jffi run --platform macos    # macOS app
jffi run --platform android  # Android Emulator
jffi run --platform linux    # Linux GTK app
jffi run --platform windows  # Windows app
jffi run --platform web      # Web browser

That's it! The app builds, compiles Rust, generates platform bindings, and launches automatically.

Check Environment Readiness

Before building or bundling for new platforms, use jffi doctor to verify that your development environment has all the required tools, SDKs, and compilers installed.

# Check environment readiness for all supported platforms
jffi doctor

# Check readiness for a specific platform
jffi doctor --platform android

Bundle Your App for Distribution

Once your application is ready, JFFI can orchestrate the packaging of release-ready artifacts (DMG, AppImage, EXE, APK, etc.) for distribution using a single command.

# Bundle for macOS (creates a .dmg)
jffi bundle --platform macos

# Bundle for Windows (creates an .exe or installer)
jffi bundle --platform windows

# Bundle for Linux (creates an .AppImage or Flatpak)
jffi bundle --platform linux

# Bundle for Android (creates an .aab or .apk)
jffi bundle --platform android

# Advanced options (code signing, notarization, specific formats)
jffi bundle --platform macos --format app --profile release --notarize

📱 Supported Platforms

Platform	Status	UI Framework	Language
iOS	✅ Ready	SwiftUI	Swift
macOS	✅ Ready	SwiftUI	Swift
Android	✅ Ready	Jetpack Compose	Kotlin
Linux	✅ Ready	GTK 4 + Libadwaita	Python
Web	✅ Ready	Vanilla JS + WASM	JavaScript
Windows	✅ Ready	WinUI 3	C#

💻 Development Host Compatibility

JFFI currently requires the native host for building and running most desktop/mobile platforms. Android and Web are cross-platform by default.

Target Platform	Mac Host	Windows Host	Linux Host
iOS	✅ Native	❌ No	❌ No
macOS	✅ Native	❌ No	❌ No
Android	✅ Native	✅ Native	✅ Native
Windows	❌ No	✅ Native	❌ No
Linux	❌ No	❌ No	✅ Native
Web	✅ Native	✅ Native	✅ Native

Note: Android and Web can be developed from any host. Other platforms currently require their respective native host for UI development and execution.

🤖 Android: Automatic ndk-context Support

JFFI automatically handles the UniFFI + JNA + ndk-context incompatibility for Android apps using networking libraries.

The Problem:

UniFFI uses JNA (Java Native Access) which doesn't call JNI_OnLoad
Some Rust crates (like hickory-resolver used by iroh) need Android context for DNS resolution
Without initialization, apps crash with: android context was not initialized

JFFI's Solution: When building for Android, JFFI automatically:

Detects if your Rust dependencies use ndk-context (via cargo tree)
Generates a JNI bridge (core/src/android.rs) to initialize ndk-context
Creates a Kotlin helper (JffiAndroidInit.kt) with initNdkContext() method
Injects the initialization call in MainActivity.onCreate()
Updates core/Cargo.toml with ndk-context and jni dependencies
Configures 16 KB page alignment for all Rust libraries (.cargo/config.toml)
Sets android:extractNativeLibs="true" for prebuilt AAR dependencies (JNA, ML Kit)

Result: Android apps using networking libraries (iroh, hickory-resolver, etc.) work out of the box with zero configuration.

Note on 16 KB Alignment:

Your Rust code: ✅ Automatically aligned via linker flags
Prebuilt AARs (JNA, ML Kit): ❌ Not aligned (upstream issue)
Solution: extractNativeLibs="true" extracts libraries at install time (official Android approach)

Note on Production Bundling & Signing Environment:

When running jffi bundle --platform android, JFFI's build orchestrator automatically generates a production signing configuration block derived from your jffi.toml profiles.

Secure Interactive Prompts (recommended): If the signing environment variables are not pre-set, jffi bundle will securely prompt you for your keystore and key passwords at runtime with masked input — no plaintext exposure in shell history:

🔑 Env var JFFI_ANDROID_STORE_PASSWORD not set. Keystore password is required for signing.
Enter Android Keystore Password (JFFI_ANDROID_STORE_PASSWORD): ••••••••••••••
🔑 Env var JFFI_ANDROID_KEY_PASSWORD not set. Key password is required for signing.
Enter Android Key Password (JFFI_ANDROID_KEY_PASSWORD): ••••••••••••••

CI/CD (non-interactive): For automated pipelines, export the variables before invoking the command:
```
export JFFI_ANDROID_STORE_PASSWORD=your_keystore_password
export JFFI_ANDROID_KEY_PASSWORD=your_key_password
jffi bundle --platform android
```
⚠️ Never hard-code passwords in scripts committed to version control. Use CI secret management (e.g. GitHub Actions Secrets, GitLab CI Variables, Fastlane Match).

References:

🏗️ Project Structure

my-app/
├── core/                    # Rust business logic + UniFFI exports
│   ├── src/lib.rs
│   └── Cargo.toml
│
├── ffi-web/                 # WASM FFI wrapper (present when web is enabled)
│   └── src/lib.rs
│
├── platforms/
│   ├── ios/                 # iOS SwiftUI app (auto-generated Xcode project)
│   ├── android/             # Android Jetpack Compose app
│   ├── macos/               # macOS SwiftUI app
│   ├── linux/               # GTK 4 Python app
│   ├── windows/             # WinUI 3 C# app
│   └── web/                 # Vanilla JS + Vite frontend
│
├── jffi.toml                # Framework configuration
├── Cargo.toml               # Workspace manifest
└── Makefile                 # Convenience commands

Development Workflow

1. Write Business Logic + Expose via UniFFI

core/src/lib.rs:

use uniffi;

#[derive(uniffi::Object)]
pub struct Core {
    // Pure computation, no UI state
}

#[uniffi::export]
impl Core {
    #[uniffi::constructor]
    pub fn new() -> Self {
        Self {}
    }

    pub fn greeting(&self) -> String {
        "Hello from JFFI".to_string()
    }

    pub fn process_data(&self, input: String) -> String {
        format!("Processed: {}", input)
    }
}

uniffi::setup_scaffolding!();

2. Build & Run

For iOS:

jffi run --platform ios              # Simulator
jffi run --platform ios --device     # Physical device

For Android:

jffi run --platform android          # Emulator (auto-starts)

For macOS:

jffi run --platform macos

For Linux:

jffi run --platform linux

For Web:

jffi run --platform web

For Windows:

jffi run --platform windows

This automatically:

iOS/macOS: Compiles Rust, generates Swift bindings, creates Xcode project, builds and launches
Android: Compiles Rust for 3 architectures, generates Kotlin bindings, starts emulator, builds APK, installs and launches app
Linux: Compiles Rust, generates Python bindings, installs dependencies (GTK 4, build tools), builds and launches GTK app
Web: Compiles Rust to WASM, generates JavaScript bindings, installs npm dependencies, starts Vite dev server
Windows: Compiles Rust, generates C# bindings with uniffi-bindgen-cs, builds with MSBuild/dotnet, launches WinUI 3 app

3. Use in Native UI

platforms/ios/ContentView.swift:

Button("Refresh") {
    greeting = core.greeting()
}

The generated bindings make Rust functions available natively in Swift, Kotlin, C#, Python, and JavaScript.

⚡ Hot Reload

JFFI works seamlessly with native IDE hot reload plus automatic Rust rebuilding.

iOS/macOS Workflow

# Start Rust file watcher
jffi dev --platform ios

# In Xcode:
# 1. Open platforms/ios/*.xcodeproj in Xcode
# 2. Run the app (Cmd+R)
# 3. Edit Swift files → Xcode hot reloads automatically ⚡
# 4. Edit Rust files → Watcher rebuilds dylib → Press Cmd+B in Xcode

Android Workflow

# Start Rust file watcher + Android Studio
jffi dev --platform android

# In Android Studio:
# 1. Press ▶️ to run the app
# 2. Edit Kotlin files → Compose hot reloads automatically ⚡
# 3. Edit Rust files → Watcher rebuilds .so → Rebuild in Android Studio

Linux Workflow

# Start Rust file watcher
jffi dev --platform linux

# The app will auto-restart when Rust code changes
# 1. Edit Python/GTK files → Save and re-run
# 2. Edit Rust files → Watcher rebuilds .so → App auto-restarts ⚡

Web Workflow

# Start Rust file watcher + Vite dev server
jffi dev --platform web

# Vite provides hot reload for JS/CSS changes
# 1. Edit HTML/JS/CSS → Vite hot reloads instantly ⚡
# 2. Edit Rust files → Watcher rebuilds WASM → Refresh browser

Note on Web Builds & C Compilers: jffi automatically unsets CC_wasm32_unknown_unknown to prevent build failures if you have it set in your shell profile (e.g. for esp32 development). If you need to override it, you can run: CC_wasm32_unknown_unknown=clang jffi dev --platform web

How It Works

Native UI Changes:

iOS/macOS: Edit .swift files → Xcode hot reloads instantly
Android: Edit .kt files → Compose hot reloads automatically
Web: Edit .js/.css files → Vite hot reloads instantly
Use native IDE features (SwiftUI previews, Compose previews, etc.)
Full debugging support

Rust Changes:

Edit any .rs file in core/ or ffi/
File watcher rebuilds Rust library automatically
Rebuild in native IDE to use new Rust code
App updates with new business logic

Best of Both Worlds

✅ Native IDE experience - Use all platform IDE features ✅ Native UI previews - SwiftUI/Compose previews work ✅ Native hot reload - Instant UI updates ✅ Rust auto-rebuild - No manual cargo commands ✅ Full debugging - Native debuggers work normally

CLI Commands

# Create new project
jffi new <name> --platforms <platforms>

# Build for platform
jffi build --platform <platform>
jffi build --platform ios --device          # Build for physical device

# Run on platform (builds automatically)
jffi run --platform <platform>
jffi run --platform ios --device            # Run on physical device

# Development mode (auto-rebuild on changes)
jffi dev --platform <platform>

# Add platform to existing project
jffi add <platform>

# Remove platform from existing project
jffi remove <platform>

# List available platforms
jffi platforms

How It Works

┌─────────────────────────────────────────┐
│     Your Rust Business Logic           │
│     (core/src/lib.rs)                   │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│     UniFFI FFI Layer                    │
│     (ffi/src/lib.rs)                    │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│     Auto-Generated Bindings             │
│     (Swift, Kotlin, C#, etc.)           │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│     Native Platform UI                  │
│     (SwiftUI, Compose, WinUI, etc.)     │
└─────────────────────────────────────────┘

Configuration

jffi.toml:

[package]
name = "my-app"
version = "0.1.0"

[platforms]
enabled = ["ios"]

[platforms.ios]
deployment_target = "16.0"
bundle_id = "com.example.myapp"

Why JFFI?

Feature	JFFI	Flutter	React Native
Business Logic	Rust	Dart	JavaScript
UI	Native	Cross-platform	Near-native
Performance	Native	Good	Good
Platform Feel	Native	Consistent	Near-native
Type Safety	End-to-end	Strong	Weak

Use JFFI when:

You want truly native UI and performance
You have platform-specific design requirements
You want to leverage native UI libraries
You need Rust for business logic (performance, safety)

🛠️ Development

Prerequisites

Rust toolchain
iOS: Xcode, iOS Simulator
Android: Android Studio, Android SDK, Android Emulator (auto-configured)
macOS: Xcode
Linux: GTK 4, Libadwaita, Python 3 (auto-installed by setup script)
Web: Node.js, npm (for Vite dev server)
Windows: .NET SDK 8.0+, Visual Studio Build Tools or MSBuild

Building the CLI

cargo build --package jffi
cargo run --package jffi -- --help

Roadmap

CLI tool foundation
iOS support with SwiftUI
macOS support with SwiftUI
Android support with Jetpack Compose
Linux support with GTK 4 + Python
Web support with Vanilla JS + WASM
Windows support with WinUI 3 + C#
Automatic Xcode project generation
Automatic Android project generation
One-command build and run (iOS, macOS, Android, Linux, Windows)
Hot reload for iOS (Xcode-native workflow)
Hot reload for Android (Android Studio-native workflow)
Hot reload for Linux (auto-restart workflow)
Hot reload for Web (Vite hot reload)
Automatic emulator/simulator management
Auto-install build dependencies (targets, NDK, GTK, WASM, wasm-bindgen, uniffi-bindgen-cs, etc.)
Full cross-compilation support (build any platform from any host)
- macOS -> Windows (via MinGW/Wine)
- Linux -> Windows (via MinGW/Wine)
- Linux -> macOS/iOS (via osxcross)
- Windows -> Linux (via WSL or cross-rs)

🤝 Contributing

Early-stage framework. Contributions welcome!

High priority:

Additional platform features and improvements
State persistence (SQLite/local storage)
Advanced UI components and patterns
Hot reload for Windows (file watcher workflow)

📄 License

GPL-3.0

Acknowledgments

UniFFI - FFI bindings generator
The Rust community

Built with and Rust

jffi 0.3.8

JFFI

Philosophy

Quick Start

Installation

Create Your First App

Check Environment Readiness

Bundle Your App for Distribution

📱 Supported Platforms

💻 Development Host Compatibility

🤖 Android: Automatic ndk-context Support

🏗️ Project Structure

Development Workflow

1. Write Business Logic + Expose via UniFFI

2. Build & Run

3. Use in Native UI

⚡ Hot Reload

iOS/macOS Workflow

Android Workflow

Linux Workflow

Web Workflow

How It Works

Best of Both Worlds

CLI Commands

How It Works

Configuration

Why JFFI?

🛠️ Development

Prerequisites

Building the CLI

Roadmap

🤝 Contributing

📄 License

Acknowledgments