e7a4130d2d
Added parameters/return values to signal failure. In particular, we need a way to signal that the foreign executor has been cancelled/closed and therefore any futures that depend on it should be halted. This is needed to fix #1669. Updated the Rust code to check for executor failures. We need to release any references passed to the waker callback since that callback will not run in that case. Updated the foreign code to handle cancelled futures. Reworked and updated unit tests to test the new system. Bumped `UNIFFI_CONTRACT_VERSION` since this requires changing the scaffolding API. I think this is correct, although you could make the argument that it's not needed since the async code is still fairly experimental. Updated the `uniffi-versioning.md` doc now that `UNIFFI_CONTRACT_VERSION` lives in `uniffi_meta`. |
||
|---|---|---|
| .cargo | ||
| .circleci | ||
| .github | ||
| docker | ||
| docs | ||
| examples | ||
| fixtures | ||
| uniffi | ||
| uniffi_bindgen | ||
| uniffi_build | ||
| uniffi_checksum_derive | ||
| uniffi_core | ||
| uniffi_macros | ||
| uniffi_meta | ||
| uniffi_testing | ||
| uniffi_udl | ||
| weedle2 | ||
| .dockerignore | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| release.toml | ||
| rust-toolchain.toml | ||
README.md
UniFFI - a multi-language bindings generator for Rust
UniFFI is a toolkit for building cross-platform software components in Rust.
By writing your core business logic in Rust and describing its interface in a special interface definition file, you can use UniFFI to help you:
- Compile your Rust code into a shared library for use on different target platforms.
- Generate bindings to load and use the library from different target languages.
For example, UniFFI is currently used in the mozilla/application-services project to build browser storage and syncing functionality for Firefox mobile browsers. Core functionality is written once in Rust, and auto-generated bindings allow that functionality to be called from both Kotlin (for Android apps) and Swift (for iOS apps).
Currently first-party supported foreign languages include Kotlin, Swift, Python and Ruby. Additional foreign language bindings can be developed externally and we welcome contributions to list them here. See Third-party foreign language bindings.
User Guide
You can read more about using the tool in the UniFFI user guide.
Please be aware that UniFFI is being developed concurrently with its initial consumers, so it is changing rapidly and there are a number of sharp edges to the user experience. Still, we consider is developed enough for production use in Mozilla products and we welcome any feedback you may have about making it more broadly useful.
Etymology and Pronunciation
ˈjuːnɪfaɪ. Pronounced to rhyme with "unify".
A portmanteau word that also puns with "unify", to signify the joining of one codebase accessed from many languages.
uni - [Latin ūni-, from ūnus, one] FFI - [Abbreviation, Foreign Function Interface]
Alternative tools
Other tools we know of which try and solve a similarly shaped problem are:
(Please open a PR if you think other tools should be listed!)
Third-party foreign language bindings
- Kotlin Multiplatform support. The repository contains Kotlin Multiplatform bindings generation for UniFFI, letting you target both JVM and Native.
- Go bindings
- C# bindings
External resources
There are a few third-party resources that make it easier to work with UniFFI:
- Plugin support for
.udlfiles for the IDEA platform (uniffi-dl in the JetBrains marketplace). It provides syntax highlighting, code folding, code completion, reference resolution and navigation (among others features) for the UniFFI Definition Language (UDL). - cargo swift, a cargo plugin to build a Swift Package from Rust code. It provides an init command for setting up a UniFFI crate and a package command for building a Swift package from Rust code - without the need for additional configuration or build scripts.
(Please open a PR if you think other resources should be listed!)
Contributing
If this tool sounds interesting to you, please help us develop it! You can:
- View the contributor guidelines.
- File or work on issues here in GitHub.
- Join discussions in the #uniffi:mozilla.org room on Matrix.
Code of Conduct
This project is governed by Mozilla's Community Participation Guidelines.