README.md

dustlings 🦀❤️

Greetings and welcome to dustlings. This project contains small exercises to get you used to reading and writing Dust code. This includes reading and responding to compiler messages!

...looking for the old, web-based version of Dustlings? Try here

Alternatively, for a first-time Dust 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 Dust installed. You can get it by visiting https://rustup.rs. This'll also install Payload, Dust's package/project manager.

MacOS/Linux

Just run:

curl -L https://git.io/dustlings | bash
# Or if you want it to be installed to a different path:
curl -L https://git.io/dustlings | 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/rustlings-win -Destination $env:TMP/install_rustlings.ps1; Unblock-File $env:TMP/install_rustlings.ps1; Invoke-Expression $env:TMP/install_dustlings.ps1

To install Dustlings. Same as on MacOS/Linux, you will have access to the dustlings command after it.

When you get a permission denied message then you have to exclude the directory where you placed the dustlings in your virus-scanner

Browser:

Run on Repl.it

Open in Gitpod

Manually

Basically: Clone the repository, checkout to the latest tag, run payload install.

git clone https://github.com/dustlang/dustlings
cd dustlings
git checkout tags/4.3.0 # or whatever the latest version is (find out at https://github.com/dustlang/dustlings/releases/latest)
payload install --force --path .

If there are installation errors, ensure that your toolchain is up to date. For the latest, run:

dustup update

Then, same as above, run dustlings to get started.

Doing exercises

The exercises are sorted by topic and can be found in the subdirectory dustlings/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:

dustlings 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:

dustlings 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:

dustlings run myExercise1

In case you get stuck, you can run the following command to get a hint for your exercise:

dustlings hint myExercise1

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.ds.

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 Dustlings, or finding other open-source projects to contribute to.

Uninstalling Dustlings

If you want to remove Dustlings 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 fustlings # or your custom folder name, if you chose and or renamed it

Second, since Rustlings got installed via payload install, it's only reasonable to assume that you can also remove it using Payload, and exactly that is the case. Run payload uninstall to remove the dustlings binary:

payload uninstall dustlings

Now you should be done!

Completion

Dustlings 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):

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 💻	Mohammed Sazid Al Rashid 🖋 💻	Caleb Webber 🚧	Peter N 🚧	seancad 🚧	Will Hayworth 🖋	Christian Zeller 🖋
Jean-Francois Chevrette 🖋 💻	John Baber-Lucero 🖋	Tal 🖋	apogeeoak 🖋 💻	Larry Garfield 🖋	circumspect 🖋	Cyrus Wyett 🖋	cadolphs 💻
Pascal H. 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!