Rust support in ASfP

Overview

Rust is a modern systems programming language focused on performance and safety, particularly memory safety. Rust is increasingly important in the Android ecosystem as a safer alternative to C or C++ for developing critical system components, offering improved security and stability.

This page guides you through setting up Android Studio for Platform (ASfP) to support Rust development within your Android Open Source Project (AOSP) projects.

Prerequisites

  • ASfP installed: Verify you have ASfP installed and running.
  • Platform checkout: You need a working AOSP platform checkout on your machine.

Enable Rust support

Here's the step-by-step process to get Rust support working in your ASfP project:

  1. Enable Rust

    • When creating a new project in the setup wizard, select the checkbox for Rust:
    Rust checkbox in new project setup wizard.
    Rust checkbox in new project setup wizard.
    • For existing projects, open your .asfp-project configuration file and add rust to other_languages:
        other_languages:
      -   cpp
      -   rust
    ```

<figure>
      <img src="/studio/platform/images/1-modify_asfp_project_languages.png" alt="Modifying the .asfp-project file to add rust to other_languages" class="screenshot">
      <figcaption>Adding Rust support in the <code>.asfp-project</code> file.</figcaption>
    </figure>

  1. Sync your project

    Trigger a project sync so the IDE generates and indexes your Rust crates: select ASfP > Sync > Sync Project.

Verify your configuration

After you complete these steps, verify the following results:

  • rust-project.json appears in your project view under the source .iml file. This file is generated by Soong during analysis and symlinked to the repository root, which is necessary for the Language Server Protocol (LSP) to provide language services. Don't edit this file directly; instead, resync to let Soong handle it.

    Verify that rust is present under other_languages in your .asfp-project configuration.

    Ensure that rust-project.json has been generated.
    Ensure that rust-project.json has been generated.

  • Your IDE enables the following Rust-specific features.

Key Rust IDE features

  • Built-in LLDB debugging and variable visualizers: Debug running Rust device services from Run > Attach to Android Process. You can also launch rust_test or rust_test_host targets directly from Android.bp gutter icons using ASfP's built-in LLDB debugger (lldb-dap), with automatic pretty-printers for String, Vec, HashMap, and Option. For more information, see Debug Rust code.

  • Code completion: Get intelligent suggestions for Rust code, including items from other modules.

    Rust cross-module code completion example
    Code completion suggesting items from a different Rust module.

  • Navigation: Jump to definitions and find usages of Rust symbols across your project.

    Rust code navigation example
    Navigating to the definition of a Rust symbol.
    Rust find usages example
    Finding all usages of a Rust symbol.

  • Tooltips: Hold the pointer over symbols to see type information and documentation.

    Rust tooltip example
    Tooltip showing type information for a Rust symbol from another module.

  • Inlay hints: View type information and other contextual hints directly in the editor.

    Rust inlay hints example
    Inlay hints showing type information within the code.

  • Structure view: Navigate the structure of your Rust files using the Structure tool window (View > Tool Windows > Structure).

    Rust structure view example
    The structure tool window showing the outline of a Rust file.

  • Refactoring: Safely rename symbols and update all usages.

    Rust rename symbol refactoring example
    Renaming a Rust symbol and updating all its references.

  • Real-time analysis: Get instant feedback on errors and warnings in your Rust code.

    Rust real-time code analysis example
    IDE showing real-time errors and warnings in Rust code.