Go to file
Jacob Pratt f0119130de
Rollup merge of #127668 - spencer3035:improve-slice-doc, r=jhpratt
Improved slice documentation

Improve slice documentation to include assert_eq checks for all the cases where there were existing examples. I think it makes things more clear when the documentation explicitly checks against values and shows the reader what it does.

I also started a rust internals discussion about it here: https://internals.rust-lang.org/t/improve-slice-documentaion/21168
2024-07-13 00:24:36 -04:00
.github Lower timeout of CI jobs to 4 hours 2024-07-12 11:27:46 +02:00
.reuse Rollup merge of #126876 - WaffleLapkin:unignoreconfigtoml, r=Mark-Simulacrum 2024-06-30 10:39:47 +02:00
LICENSES Add missing CC-BY-SA-4.0. 2023-11-27 11:03:53 +00:00
compiler Rollup merge of #127654 - nikic:llvm-ndebug-fix, r=cuviper 2024-07-13 00:24:35 -04:00
library Rollup merge of #127668 - spencer3035:improve-slice-doc, r=jhpratt 2024-07-13 00:24:36 -04:00
src Rollup merge of #127654 - nikic:llvm-ndebug-fix, r=cuviper 2024-07-13 00:24:35 -04:00
tests Auto merge of #127665 - workingjubilee:rollup-g90yr21, r=workingjubilee 2024-07-12 22:59:30 +00:00
.clang-format Add `.clang-format` 2024-06-26 05:56:00 +08:00
.editorconfig Only use max_line_length = 100 for *.rs 2023-07-10 15:18:36 -07:00
.git-blame-ignore-revs Ignore compiletest test directive migration commits 2024-02-22 18:55:02 +00:00
.gitattributes Rename `config.toml.example` to `config.example.toml` 2023-03-11 14:10:00 -08:00
.gitignore Avoid follow-up errors and ICEs after missing lifetime errors on data structures 2024-07-11 11:00:15 +00:00
.gitmodules refactor: add rustc-perf submodule to src/tools 2024-05-20 14:56:49 +00:00
.ignore Add `.ignore` file to make `config.toml` searchable in vscode 2024-06-24 10:15:16 +02:00
.mailmap .mailmap: Associate both my work and my private email with me 2024-06-15 09:27:39 +02:00
CODE_OF_CONDUCT.md Remove the code of conduct; instead link https://www.rust-lang.org/conduct.html 2019-10-05 22:55:19 +02:00
CONTRIBUTING.md fix: Update CONTRIBUTING.md recommend -> recommended 2023-11-16 23:57:09 +05:30
COPYRIGHT Update COPYRIGHT file 2022-10-30 10:23:14 -04:00
Cargo.lock Use uplifted `rustc-stable-hash` crate in `rustc_data_structures` 2024-07-11 16:51:16 +02:00
Cargo.toml Implement `x perf` as a separate tool 2024-06-27 10:22:03 +02:00
INSTALL.md cmake version is from LLVM, link to LLVM docs 2024-07-09 15:23:59 -04:00
LICENSE-APACHE Remove appendix from LICENCE-APACHE 2019-12-30 14:25:53 +00:00
LICENSE-MIT LICENSE-MIT: Remove inaccurate (misattributed) copyright notice 2017-07-26 16:51:58 -07:00
README.md Use SVG logos in the README.md. 2024-04-03 19:48:20 +02:00
RELEASES.md Rollup merge of #126250 - epage:change, r=Mark-Simulacrum 2024-06-17 04:53:55 +01:00
config.example.toml Remove `src/tools/rust-demangler` 2024-06-19 20:41:34 +10:00
configure Ensure `./configure` works when `configure.py` path contains spaces 2024-02-16 18:57:22 +00:00
rust-bors.toml Increase timeout for new bors bot 2024-03-13 08:31:07 +01:00
rustfmt.toml Add rustdoc-json support for use<> 2024-07-12 05:24:51 -04:00
triagebot.toml Temporarily remove me from review rotation. 2024-07-10 11:56:56 +02:00
x Make x capable of resolving symlinks 2023-10-14 17:53:33 +03:00
x.ps1 use `&` instead of start-process in x.ps1 2023-12-09 09:46:16 -05:00
x.py Fix recent python linting errors 2023-08-02 04:40:28 -04:00

README.md

This is the main source code repository for Rust. It contains the compiler, standard library, and documentation.

Why Rust?

  • Performance: Fast and memory-efficient, suitable for critical services, embedded devices, and easily integrate with other languages.

  • Reliability: Our rich type system and ownership model ensure memory and thread safety, reducing bugs at compile-time.

  • Productivity: Comprehensive documentation, a compiler committed to providing great diagnostics, and advanced tooling including package manager and build tool (Cargo), auto-formatter (rustfmt), linter (Clippy) and editor support (rust-analyzer).

Quick Start

Read "Installation" from The Book.

Installing from Source

If you really want to install from source (though this is not recommended), see INSTALL.md.

Getting Help

See https://www.rust-lang.org/community for a list of chat platforms and forums.

Contributing

See CONTRIBUTING.md.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

Trademark

The Rust Foundation owns and protects the Rust and Cargo trademarks and logos (the "Rust Trademarks").

If you want to use these names or brands, please read the media guide.

Third-party logos may be subject to third-party copyrights and trademarks. See Licenses for details.