🦀 Small exercises to get you used to reading and writing Rust code!
Find a file
Eric Eastwood a025ce0538 Add warning about rust-analyzer not working if you clone and use the repo directly
> Yes, you are right, if you just clone the repository and try to edit the exercises, the language server will not work. This is one downside of the current approach. But this only affects developing exercises.
>
> The new method of doing Rustlings is to install Rustlings using `cargo install rustlings` (not published yet), then running `rustlings init`. No repo cloning happens. Instead, the directory `rustlings/` will be created where you find the exercises. The language server works there out of the box :)
>
> I need to add a warning when people try to work on the exercises from the repository. Thanks pointing this out.
>
> -- @mo8it, https://github.com/rust-lang/rustlings/issues/1935#issuecomment-2067664066

Other references:

 - Previous `rustlings lsp` command: https://github.com/rust-lang/rustlings/pull/1026
 - The changelog says "LSP support out of the box", https://github.com/rust-lang/rustlings/blob/main/CHANGELOG.md#lsp-support-out-of-the-box
2024-10-14 14:11:09 -05:00
.github/workflows Run rustfmt on solutions in dev check 2024-08-01 19:14:09 +02:00
dev Move lint to Rust lints 2024-09-13 14:59:34 +02:00
exercises Update from_str.rs 2024-10-05 16:05:35 -04:00
rustlings-macros Replace three dots with dot in hint 2024-09-26 18:05:05 +02:00
solutions Avoid single char variables 2024-10-09 15:27:36 +02:00
src Fix typos 2024-10-14 10:17:17 -07:00
tests test_dir is a str anyway 2024-08-09 01:05:44 +02:00
.editorconfig fix: Fix typo in .editorconfig 2022-07-20 18:23:31 -04:00
.gitignore Ignore all lock files but the one in root 2024-04-21 18:20:15 +02:00
.markdownlint.yml feat(docs): add markdown linter for exercises README.md files 2023-03-30 19:53:22 +03:30
.typos.toml <s>earch isn't a typo 2024-09-13 15:07:53 +02:00
Cargo.lock Replace ahash with foldhash 2024-10-14 15:24:42 +02:00
Cargo.toml Replace ahash with foldhash 2024-10-14 15:24:42 +02:00
CHANGELOG.md Update changelog 2024-08-29 17:10:39 +02:00
clippy.toml Replace ahash with foldhash 2024-10-14 15:24:42 +02:00
CONTRIBUTING.md Update CONTRIBUTING 2024-07-02 14:45:25 +02:00
dev-Cargo.toml Include dev/Cargo.toml 2024-04-25 19:58:55 +02:00
LICENSE Update LICENSE year. 2016-03-27 15:57:49 -04:00
oranda.json Remove install page for now, README is enough 2024-07-03 16:23:23 +02:00
README.md Add warning about rust-analyzer not working if you clone and use the repo directly 2024-10-14 14:11:09 -05:00
release-hook.sh Remove redundant rustfmt check for solutions 2024-08-08 00:41:12 +02:00
THIRD_PARTY_EXERCISES.md Fix typo in THIRD_PARTY_EXERCISES.md 2024-07-06 14:30:11 +02:00

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!

It is recommended to do the Rustlings exercises in parallel to reading the official Rust book, the most comprehensive resource for learning Rust 📚

Rust By Example is another recommended resource that you might find helpful. It contains code examples and exercises similar to Rustlings, but online.

Getting Started

Installing Rust

Before installing Rustlings, you need to have the latest version of Rust installed. Visit www.rust-lang.org/tools/install for further instructions on installing Rust. This will also install Cargo, Rust's package/project manager.

🐧 If you're on Linux, make sure you've installed gcc (for a linker).

Deb: sudo apt install gcc. Dnf: sudo dnf install gcc.

🍎 If you're on MacOS, make sure you've installed Xcode and its developer tools by running xcode-select --install.

Installing Rustlings

The following command will download and compile Rustlings:

cargo install rustlings
If the installation fails… (click to expand)
  • Make sure you have the latest Rust version by running rustup update
  • Try adding the --locked flag: cargo install rustlings --locked
  • Otherwise, please report the issue

Initialization

After installing Rustlings, run the following command to initialize the rustlings/ directory:

rustlings init
If the command rustlings can't be found… (click to expand)

You are probably using Linux and installed Rust using your package manager.

Cargo installs binaries to the directory ~/.cargo/bin. Sadly, package managers often don't add ~/.cargo/bin to your PATH environment variable.

The solution is to …

Now, go into the newly initialized directory and launch Rustlings for further instructions on getting started with the exercises:

cd rustlings/
rustlings

Working environment

Editor

Our general recommendation is VS Code with the rust-analyzer plugin. But any editor that supports rust-analyzer should be enough for working on the exercises.

If you cloned the repository and rust-analyzer isn't working… (click to expand)

The intended way to run Rustlings is to install the binary and run rustlings init as described above. This generates a Cargo.toml (different than what you see in the repository) that includes the each excersise as a separate binary target which is enough for rust-analyzer to work.

If you just clone the repository and try to run and edit the exercises directly, the language server will not work. This is one downside of the current approach. But this only affects developing exercises.

Terminal

While working with Rustlings, please use a modern terminal for the best user experience. The default terminal on Linux and Mac should be sufficient. On Windows, we recommend the Windows Terminal.

Doing exercises

The exercises are sorted by topic and can be found in the subdirectory exercises/<topic>. For every topic, there is an additional README.md file with some resources to get you started on the topic. We highly recommend that you have a look at them before you start 📚

Most exercises contain an error that keeps them from compiling, and it's up to you to fix it! Some exercises contain tests that need to pass for the exercise to be done

Search for TODO and todo!() to find out what you need to change. Ask for hints by entering h in the watch mode 💡

Watch Mode

After initialization, Rustlings can be launched by simply running the command rustlings.

This will start the watch mode which walks you through the exercises in a predefined order (what we think is best for newcomers). It will rerun the current exercise automatically every time you change the exercise's file in the exercises/ directory.

If detecting file changes in the exercises/ directory fails… (click to expand)

You can add the --manual-run flag (rustlings --manual-run) to manually rerun the current exercise by entering r in the watch mode.

Please report the issue with some information about your operating system and whether you run Rustlings in a container or virtual machine (e.g. WSL).

Exercise List

In the watch mode (after launching rustlings), you can enter l to open the interactive exercise list.

The list allows you to…

  • See the status of all exercises (done or pending)
  • c: Continue at another exercise (temporarily skip some exercises or go back to a previous one)
  • r: Reset status and file of an exercise (you need to reload/reopen its file in your editor afterwards)

See the footer of the list for all possible keys.

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.

Third-Party Exercises

Third-party exercises are a set of exercises maintained by the community. You can use the same rustlings program that you installed with cargo install rustlings to run them:

Do you want to create your own set of Rustlings exercises to focus on some specific topic? Or do you want to translate the original Rustlings exercises? Then follow the the guide about third-party exercises!

Uninstalling Rustlings

If you want to remove Rustlings from your system, run the following command:

cargo uninstall rustlings

Contributing

See CONTRIBUTING.md 🔗

Contributors

Thanks to all the wonderful contributors 🎉