.. |rust_version| replace:: 1.77.2

.. |rust_language_edition| replace:: 2021

.. |gp4r| replace:: *GNAT Pro for Rust*

.. |gp4a| replace:: *GNAT Pro for Ada*

.. _About_This_Guide:

About This Guide
****************

|gp4r| is a toolchain for developing software in the Rust programming language.
The product provides professional support for a specified version of the Rust toolset; it is not a fork of the Rust programming language or the Rust tools.
For more information, see :ref:`Getting_Started_with_GNAT_Pro_for_Rust`.

This guide documents how to install the product and how to build, run, and debug both native and cross-compiled applications.
It also shows how to build mixed-language programs (Rust and Ada), which is supported if you have subscriptions to both |gp4r| and |gp4a|.

|gp4r| |version| implements version |rust_version| of the Rust toolchain, for the |rust_language_edition| edition of the Rust language.

What This Guide Contains
========================

This guide contains the following chapters:

* :ref:`Getting_Started_with_GNAT_Pro_for_Rust` describes what the product includes, which platform configurations are supported, how to install the product, and how to verify that the installation was successful.

* :ref:`Developing_Mixed_Language_Projects` describes how to build programs that contain code in both Rust and Ada.

Appendices cover additional topics:

* :ref:`Platform_Specific_Information` describes product details and program build/debug characteristics that are specific to the various native and embedded target configurations.

* :ref:`apache_license` contains the license for this document.

What You Should Know before Reading This Guide
==============================================

This guide assumes a basic familiarity with the Rust language and toolset.

Related Information
===================

For references to on-line resources for the Rust language and tools, please see :ref:`Getting_Started_Documentation`.

Conventions
===========

* Commands that are entered by the user are shown as preceded by a prompt string comprising the ``$`` character followed by a space.

* Regardless of whether the host platform is Linux or Windows, paths are shown with the ``/`` character as the directory separator; e.g., :file:`my_package/src/main.rst`.