7928122fce
I’ve been wanting to do this for a while, but always procrastinated on it. We’ve been using Clap since the 2.0 rewrite, but Clap is known to be a fairly heavy library. Since Rustlings is usually peoples’ first contact with a Rust compilation, I think it’s in our best interests that this complation is as fast as possible. In effect, replacing Clap with the smaller, structopt-style `argh` reduces the amount of crates needing to be compiled from 82 to 60. I also think this makes the code way easier to read, we don’t need to use Clap’s methods anymore, but can switch over to using pure Rust methods, e.g., switches are booleans, options are Option<String>s or the like, and subcommands are just structs. |
||
|---|---|---|
| exercises | ||
| src | ||
| tests | ||
| .all-contributorsrc | ||
| .clog.toml | ||
| .editorconfig | ||
| .gitignore | ||
| .gitpod.yml | ||
| .replit | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| default_out.txt | ||
| info.toml | ||
| install.ps1 | ||
| install.sh | ||
README.md
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
Alternatively, for a first-time Rust learner, there are several other resources:
- The Book - The most comprehensive resource for learning Rust, but a bit theoretical sometimes. You will be using this along with Rustlings!
- Rust By Example - 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:
curl -L https://git.io/install-rustlings | bash
# Or if you want it to be installed to a different path:
curl -L https://git.io/install-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:
Set-ExecutionPolicy RemoteSigned
Then, you can run:
Start-BitsTransfer -Source https://git.io/JTL5v -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.
When you get a permission denied message then you have to exclude the directory where you placed the rustlings in your virus-scanner
Browser:
Manually
Basically: Clone the repository, checkout to the latest tag, run cargo install.
git clone https://github.com/rust-lang/rustlings
cd rustlings
git checkout tags/4.3.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:
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/<topic>. 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:
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:
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:
rustlings run myExercise1
In case you get stuck, you can run the following command to get a hint for your exercise:
rustlings hint myExercise1
To check your progress, you can run the following command:
rustlings list
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.
Uninstalling Rustlings
If you want to remove Rustlings from your system, there's two steps. First, you'll need to remove the exercises folder that the install script created for you:
rm -rf rustlings # or your custom folder name, if you chose and or renamed it
Second, since Rustlings got installed via cargo install, it's only reasonable to assume that you can also remove it using Cargo, and
exactly that is the case. Run cargo uninstall to remove the rustlings binary:
cargo uninstall rustlings
Now you should be done!
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.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!