Skip to content
Compile Rust projects against the Android NDK without hassle
Rust
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix documentation on subcommand Nov 6, 2019
.gitignore Proof of concept Apr 14, 2018
Cargo.toml Fix cc not working consistently (fixes #2) Nov 6, 2019
LICENSE-APACHE Change license Jul 22, 2018
LICENSE-MIT Change license Jul 22, 2018
README.md mark Windows as supported in readme Oct 5, 2019

README.md

cargo-ndk

Use cargo with the NDK without too much hassle. Handles finding the correct linkers and converting between the triples used in the Rust world to the triples used in the Android world.

For a more manual approach, see this blog from Mozilla.

NOTE: Minimum supported NDK version is r19c.

Supported triples

  • aarch64-linux-android
  • armv7-linux-androideabi
  • i686-linux-android
  • x86_64-linux-android

Supported hosts

  • Linux
  • macOS
  • Windows

Usage

First you'll need to install all the toolchains you intend to use. Simplest way is with the following:

rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android

You'll also need the NDK installed somewhere, and the path to it exported as the NDK_HOME environment variable. On macOS with Android Studio, this is usually $HOME/Library/Android/sdk/ndk-bundle. On Linux, it's somewhere in $HOME/.android (pull requests accepted with actual location).

Install the plugin with cargo install cargo-ndk.

Then, simply run your usual cargo commands prefixed with cargo ndk --target <Android triplet> --android-platform <API> --, where API is the Android API platform version to target (for example, 16). Note the --, it is required to pass commands to cargo and not to the cargo-ndk plugin.

So, to do an ordinary release build for aarch64 against API 25, you'd run:

cargo ndk --target aarch64-linux-android --android-platform 25 -- build --release 

License

This project is licensed under either of

at your option.

You can’t perform that action at this time.