![crab pet](https://i.imgur.com/LbZJgmm.gif) [![All Contributors](https://img.shields.io/badge/all_contributors-65-orange.svg?style=flat-square)](#contributors-) # rustlings 🦀❤️ [![Build status](https://badge.buildkite.com/7af93d81dc522c67a1ec8e33ff5705861b1cb36360b774807f.svg)](https://buildkite.com/mokou/rustlings) Greetings and welcome to `rustlings`. This project contains small exercises to get you used to reading and writing Rust code. This includes reading and responding to compiler messages! _...looking for the old, web-based version of Rustlings? Try [here](https://github.com/rust-lang/rustlings/tree/rustlings-1)_ Alternatively, for a first-time Rust learner, there are several other resources: - [The Book](https://doc.rust-lang.org/book/index.html) - The most comprehensive resource for learning Rust, but a bit theoretical sometimes. You will be using this along with Rustlings! - [Rust By Example](https://doc.rust-lang.org/rust-by-example/index.html) - Learn Rust by solving little exercises! It's almost like `rustlings`, but online ## Getting Started _Note: If you're on MacOS, make sure you've installed Xcode and its developer tools by typing `xcode-select --install`._ You will need to have Rust installed. You can get it by visiting https://rustup.rs. This'll also install Cargo, Rust's package/project manager. ## MacOS/Linux Just run: ```bash curl -L https://git.io/rustlings | bash # Or if you want it to be installed to a different path: curl -L https://git.io/rustlings | bash -s mypath/ ``` This will install Rustlings and give you access to the `rustlings` command. Run it to get started! ## Windows In PowerShell, set `ExecutionPolicy` to `RemoteSigned`: ```ps Set-ExecutionPolicy RemoteSigned ``` Then, you can run: ```ps Start-BitsTransfer -Source https://git.io/rustlings-win -Destination $env:TMP/install_rustlings.ps1; Unblock-File $env:TMP/install_rustlings.ps1; Invoke-Expression $env:TMP/install_rustlings.ps1 ``` To install Rustlings. Same as on MacOS/Linux, you will have access to the `rustlings` command after it. ## Browser: [Run on Repl.it](https://repl.it/github/rust-lang/rustlings) [Open in Gitpod](https://gitpod.io/#https://github.com/rust-lang/rustlings) ## Manually Basically: Clone the repository, checkout to the latest tag, run `cargo install`. ```bash git clone https://github.com/rust-lang/rustlings cd rustlings git checkout tags/4.1.0 # or whatever the latest version is (find out at https://github.com/rust-lang/rustlings/releases/latest) cargo install --force --path . ``` If there are installation errors, ensure that your toolchain is up to date. For the latest, run: ```bash rustup update ``` Then, same as above, run `rustlings` to get started. ## Doing exercises The exercises are sorted by topic and can be found in the subdirectory `rustlings/exercises/`. For every topic there is an additional README file with some resources to get you started on the topic. We really recommend that you have a look at them before you start. The task is simple. Most exercises contain an error that keeps them from compiling, and it's up to you to fix it! Some exercises are also run as tests, but rustlings handles them all the same. To run the exercises in the recommended order, execute: ```bash rustlings watch ``` This will try to verify the completion of every exercise in a predetermined order (what we think is best for newcomers). It will also rerun automatically every time you change a file in the `exercises/` directory. If you want to only run it once, you can use: ```bash rustlings verify ``` This will do the same as watch, but it'll quit after running. In case you want to go by your own order, or want to only verify a single exercise, you can run: ```bash rustlings run myExercise1 ``` In case you get stuck, you can run the following command to get a hint for your exercise: ``` bash rustlings hint myExercise1 ``` ### Using an IDE **TL,DR**: open the `exercises/` folder in your editor while running `rustlings watch`. There are several editors and plugins that are able to analyze Rust code for a full blown IDE (or IDE-like) experience. The official language plugin of the Rust project is [rust-analyzer](rust-analyzer), but there are others, like [IntelliJ Rust](intellij) or [rls](rls). These tools usually rely on the default structure of a Cargo project to perform their analyses. Conversely, Rustlings has a _atypical_ structure: it's a collection of isolated exercises. Your editor might not be able to properly analyze the code of the exercises. However, if you run `rustlings watch`, we auto-generate a "fake" project manifest in `exercises/Cargo.toml` that points to the currently active exercise. If you open the `exercises/` folder with your Rust-enabled editor, you should be able to enjoy its capabilities. Note that we update the manifest so it always points to the current exercise, so ideally your editor should be able to refresh the project metadata automatically. [rust-analyzer]: https://rust-analyzer.github.io/ [rls]: https://github.com/rust-lang/rls [intellij]: https://intellij-rust.github.io/ ## Testing yourself After every couple of sections, there will be a quiz that'll test your knowledge on a bunch of sections at once. These quizzes are found in `exercises/quizN.rs`. ## Continuing On Once you've completed Rustlings, put your new knowledge to good use! Continue practicing your Rust skills by building your own projects, contributing to Rustlings, or finding other open-source projects to contribute to. If you'd like to uninstall Rustlings, you can do so by invoking cargo and removing the rustlings directory: ```bash cargo uninstall rustlings rm -r rustlings/ # or on Windows: rmdir /s rustlings ``` ## Completion Rustlings isn't done; there are a couple of sections that are very experimental and don't have proper documentation. These include: - Errors (`exercises/errors/`) - Option (`exercises/option/`) - Result (`exercises/result/`) - Move Semantics (could still be improved, `exercises/move_semantics/`) Additionally, we could use exercises on a couple of topics: - Structs - Better ownership stuff - `impl` - ??? probably more If you are interested in improving or adding new ones, please feel free to contribute! Read on for more information :) ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md). ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Carol (Nichols \|\| Goulding)} 💻 🖋	_{QuietMisdreavus} 💻 🖋	_{Robert M Lugg} 🖋	_{Hynek Schlawack} 💻	_{Katharina Fey} 💻	_lukabavdaz 💻 🖋	_{Erik Vesteraas} 💻	_delet0r 💻
_{Shaun Bennett} 💻	_{Andrew Bagshaw} 💻	_{Kyle Isom} 💻	_{Colin Pitrat} 💻	_{Zac Anger} 💻	_{Matthias Geier} 💻	_{Chris Pearce} 💻	_{Yvan Sraka} 💻
_{Denys Smirnov} 💻	_eddyp 💻	_{Brian Kung} 💻 🖋	_Russell 💻	_{Dan Wilhelm} 📖	_Jesse 💻 🖋	_{Fredrik Jambrén} 💻	_{Pete McFarlane} 🖋
_nkanderson 💻 🖋	_{Ajax M} 📖	_{Dylan Nugent} 🖋	_vyaslav 💻 🖋	_George 💻	_{Thomas Holloway} 💻 🖋	_Jubilee 💻	_WofWca 💻
_{Roberto Vidal} 💻 📖 🤔 🚧	_Jens 📖	_{Rahat Ahmed} 📖	_{Abdou Seck} 💻 🖋 👀	_Katie 💻	_Socrates 📖	_gnodarse 🖋	_{Harrison Metzger} 💻
_{Torben Jonas} 💻 🖋	_{Paul Bissex} 📖	_{Steven Mann} 💻 🖋	_{Mario Reder} 💻 🖋	_skim 💻	_{Sanjay K} 💻 🖋	_{Rohan Jain} 💻	_{Said Aspen} 💻 🖋
_{Ufuk Celebi} 💻	_{lebedevsergey} 📖	_{Aleksei Trifonov} 🖋	_{Darren Meehan} 🖋	_{Jihchi Lee} 🖋	_{Christofer Bertonha} 🖋	_{Vivek Bharath Akupatni} 💻 ⚠️	_{Dídac Sementé Fernández} 💻 🖋
_{Rob Story} 💻	_{Siobhan Jacobson} 💻	_{Evan Carroll} 🖋	_{Jawaad Mahmood} 🖋	_{Gaurang Tandon} 🖋	_{Stefan Kupresak} 🖋	_{Greg Leonard} 🖋	_{Ryan McQuen} 💻
_Annika 👀	_{Axel Viala} 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!