DOCSEARCHbyAlgolia
Submit Docs

Rust Programming Language

repository·main·Indexed 12 days ago

https://github.com/rust-lang/rust

The central source for the Rust programming language, including the rustc compiler, standard library, and core documentation. This repository contains internal compiler components such as rustc_ast for syntax handling, rustc_codegen_llvm and the Cranelift backend for code generation, and the rustc_public crate for providing a stable interface to external tools.

Tokens
612.2K
Snippets
1.9K
Records
3K
Agent score
95%

What's inside Rust

  1. Overview of the rustc_ast crate

    main
    The rustc_ast crate is the central component in the Rust compiler responsible for handling syntax. It provides the Abstract Syntax Tree (AST) representation, definitions for tokens and token streams, and the data structures and traits required for mutating ASTs. It also contains shared definitions used by other compiler components, such as the lexer and the macro-expansion system.

  3. What is rust-analyzer and how to use it

    main

    rust-analyzer is a language server that provides IDE functionality for writing Rust programs. It implements the Language Server Protocol (LSP), allowing it to be used with any editor that supports LSP, such as VS Code, Vim, Emacs, or Zed.

    Key features include:

    • Go-to-definition
    • Find-all-references
    • Refactorings
    • Code completion
    • Integrated formatting (via rustfmt)
    • Integrated diagnostics (via rustc and clippy)

  4. Overview of the shim_utils crate

    main
    shim_utils is a lightweight library crate designed to provide shared code for the rustc and rustdoc shims used during the bootstrapping process. It is intended to be used by bootstrap or other bootstrap-related tools. Using this dedicated crate is preferred over linking larger crates like build_helper or bootstrap into the shims to ensure faster linking times.

  5. Overview of compiler-builtins and libm

    main

    The compiler-builtins and libm crates provide essential low-level functionality for the Rust ecosystem:

    • compiler-builtins: Provides symbols that the Rust compiler expects to be available at link time. These are often low-level primitives required for the language to function correctly.
    • libm: A Rust implementation of C math libraries. It is used to provide mathematical implementations within the core library.

  6. What is rust-analyzer

    main

    rust-analyzer is a language server that provides IDE functionality for writing Rust programs. It implements the Language Server Protocol (LSP), making it compatible with any editor that supports LSP, such as VS Code, Vim, Emacs, and Zed.

    Key features include:

    • Navigation: go-to-definition, find-all-references.
    • Editing: refactorings, code completion.
    • Tooling Integration: integrated formatting (via rustfmt) and integrated diagnostics (via rustc and clippy).

  7. Overview of Rust tool and language documentation

    main

    For developers moving beyond basic language syntax, the following specialized books provide deep dives into the ecosystem:

    • The Standard Library: Extensive API documentation for core types and traits.
    • The rustc Book: Documentation regarding the Rust compiler.
    • The Cargo Book: A guide to Rust's build tool and dependency manager.
    • The Rustdoc Book: Documentation for the rustdoc tool.
    • The Clippy Book: Documentation for the Clippy static analyzer.
    • The Reference: A detailed and comprehensive technical reference of the language.
    • The Rustonomicon: A guide to writing safe code using unsafe Rust.
    • The Unstable Book: Documentation for features that are not yet stable.

  8. Overview of the opt-dist build pipeline

    main

    The opt-dist binary provides a heavily optimized build pipeline specifically for rustc and LLVM artifacts. It is designed for two primary use cases:

    1. Benchmarking: Generating artifacts for use by the perf.bot.
    2. Distribution: Creating optimized builds for final distribution to users.

    Unlike the standard bootstrap process, opt-dist is a separate tool because it requires complex orchestration, including multiple bootstrap invocations, forced rebuilds of specific artifacts, and the ability to bypass the standard bootstrap caching mechanism to apply advanced optimizations.

  9. Overview of compiler-builtins

    main

    The compiler-builtins crate provides external symbols that the Rust compiler expects to be available during the build process. These symbols are typically software routines for basic operations that lack direct hardware support. The crate is largely a port of LLVM's compiler-rt and is distributed as part of the Rust sysroot.

    Because it is part of the sysroot, you do not need to add compiler-builtins as an explicit dependency in your Cargo.toml.

  11. Overview of Rustdoc JSON Types

    main

    The rustdoc-json-types crate provides a set of Rust types with serde implementations that represent the Rustdoc JSON API.

    This crate is designed to allow consumers to easily parse and interact with the JSON output produced by rustdoc. By providing these types in a dedicated crate, the Rust project can version the data structures independently of rustc/rustdoc internals. The versioning follows semantic versioning (semver) guarantees: a specific version of the JSON format will remain compatible with a corresponding version of rustdoc-json-types.

  12. Overview of MIR to Binaries pipeline

    main
    The Rust compiler transforms Mid-level Intermediate Representation (MIR) into executable binaries through several stages. This pipeline includes MIR optimizations, constant evaluation (via an interpreter), monomorphization of generics, lowering MIR to LLVM IR, and finally code generation. The process also involves generating debug information and managing libraries and metadata.