Skip to content
This repository has been archived by the owner on Sep 30, 2020. It is now read-only.

Latest commit

 

History

History
108 lines (78 loc) · 3.6 KB

documentation.md

File metadata and controls

108 lines (78 loc) · 3.6 KB
layout title
default
Rust Documentation · The Rust Programming Language

Rust Documentation

If you haven't seen Rust at all yet, the first thing you should read is the introduction to the book, The Rust Programming Language. It will give you a good idea of what Rust is like, show you how to install it, and explain its syntax and concepts. Upon completing the book, you'll be an intermediate Rust developer, and will have a good grasp of the fundamental ideas behind Rust.

Learning Rust

The Rust Programming Language. Also known as "The Book", The Rust Programming Language will introduce you to the main topics important to learning Rust, and get you to the point where you can be productive. The book is the primary official document of the language.

Rust by Example. A collection of self-contained Rust examples on a variety of topics, executable in-browser.

Frequently asked questions.

The Rustonomicon. An entire book dedicated to explaining how to write unsafe Rust code. It is for advanced Rust programmers.

rust-learning. A community-maintained collection of resources for learning Rust.

References

Standard Library API Reference. Documentation for the standard library.

docs.rs. Documentation for all crates published to crates.io.

The Rust Reference. While Rust does not have a specification, the reference tries to describe its working in detail. It tends to be out of date.

Syntax Index. This appendix from The Book contains examples of all syntax in Rust cross-referenced with the section of The Book that describes it.

The Cargo Guide. The documentation for Cargo, Rust's package manager.

Compiler Error Index. Extended explanations of the errors produced by the Rust compiler.

Release Notes. A recording of changes made during each release.

Platform Support. List of platforms in each support tier.

Project policies

Rust security policy. The project's policies for reporting, fixing and disclosing security-related bugs.

Rust copyright and trademark policies. The Rust copyrights are owned by The Rust Project Developers, and its trademarks are owned by Mozilla. Appropriate usage of Rust's trademarks are described here.

Code of Conduct. Applies to the rust-lang organization on GitHub, the official forums, IRC channels, and various other corners of the Rust world.

Nightly and beta documentation

Much of the official Rust documentation is also available for the nightly and beta releases in addition to the stable documentation linked above.

Non-english resources

For resources in languages other than English, see the locale-specific links in rust-learning.