X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/d9fc9a4d89d8e4950f43308318962d9179bd1177..501b20b712b2e5c176ca581232970e1e74d62ab0:/src/main.rs?ds=inline diff --git a/src/main.rs b/src/main.rs index d7dbcb0..02766c6 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,18 +1,13 @@ // Welcome to Rust-101 // =================== // -// This is [Rust-101](https://www.ralfj.de/projects/rust-101/), a small *work-in-progress* -// tutorial for the [Rust language](http://www.rust-lang.org/). -// It is intended to be an interactive, hands-on course: I believe the only way to -// *really* learn a language is to write code in it, so you should be coding during -// the course. I am writing this with a tutorial situation in mind, i.e., -// with a teacher being around to guide students through the course and answer -// questions as they come up. However, I think they may also be useful if you -// work through them on your own, you will just have to show more initiative yourself: -// Make sure you actually type some code. It may sound stupid to manually copy code -// that you could duplicate through the clipboard, but it's actually helpful. -// If you have questions, check out the "Additional Resources" below. In particular, -// the IRC channel is filled with awesome people willing to help you! I spent +// This is [Rust-101](https://www.ralfj.de/projects/rust-101/), a small tutorial for +// the [Rust language](http://www.rust-lang.org/). It is intended to be an interactive, +// hands-on course: I believe the only way to *really* learn a language is to write code +// in it, so you should be coding during the course. +// +// If you have any questions that are not answered here, check out the "Additional Resources" +// below. In particular, the IRC channel is filled with awesome people willing to help you! I spent // lots of time there ;-) // // I will assume some familiarity with programming, and hence not explain the basic @@ -22,64 +17,76 @@ // --------- // // When you got here, I am kind of assuming that you already decided to give Rust at -// least a look, so that I don't have to do much convincing here ;-) . But just in +// least a look, so that I don't have to do much convincing here. But just in // case, here's why I think Rust is worth learning:
// At this time, Rust is a language with a pretty unique set of goals. Rust aims to // achieve C++-style control over memory and execution behavior (like, static vs. dynamic // dispatch), which makes it possible to construct abstractions that carry no run-time // cost. This is combined with the comfort of high-level functional languages and guaranteed // safety (as in, the program will not crash). The vast majority of existing -// languages sacrificies one of these goals for the other. In particular, the -// first requirement rules out a garbage collector: Rust can run "mare metal". +// languages sacrifices one of these goals for the other. In particular, the +// first requirement rules out a garbage collector: Rust can run "bare metal". // In fact, Rust rules out more classes of bugs than languages that achieve safety // with a GC: Besides dangling pointers and double-free, Rust also prevents issues -// such as iterator invalidation and race conditions. +// such as iterator invalidation and data races. // // // Getting started // --------------- // // You will need to have Rust installed, of course. It is available for download on -// [the Rust website](http://www.rust-lang.org/). At this point, I plan to restrict -// myself to stable Rust, so "Recommended" version is just right. -// You can find some more installation instructions in -// [the second chapter of The Book](https://doc.rust-lang.org/stable/book/installing-rust.html). +// [the Rust website](http://www.rust-lang.org/). Make sure you get at least version 1.2 +// (at the time of writing, that's the current beta release). More detailed installation +// instructions are provided in [the second chapter of The Book](https://doc.rust-lang.org/stable/book/installing-rust.html). +// This will also install `cargo`, the tool responsible for building rust projects (or *crates*). // Next, fetch the Rust-101 source code from the [git repository](http://www.ralfj.de/git/rust-101.git) -// (also available [on GitHub](https://github.com/RalfJung/rust-101)). Running `cargo build` -// in the root of the repository should now succeed. +// (also available [on GitHub](https://github.com/RalfJung/rust-101), and as a +// [zip archive](https://github.com/RalfJung/rust-101/archive/master.zip) in case you don't have git installed). // -// I suggest you copy the folder `workspace` somewhere you like, so that you can still easily -// `git pull` updates in the main repository. After copying, try `cargo build` in the -// new location. It should complain about `part00::main()` not being found. Now you can start -// by following [Part 00](part00.html), typing in `part00.rs`. If you need to add a new file, remember to also -// add it to `main.rs` so that Rust finds it. +// There is a workspace prepared for you in the `workspace` folder. I suggest you copy this +// folder somewhere else - that will make it much easier to later update the course without +// overwriting your changes. Try `cargo build` in that new folder to check that compiling your workspace succeeds. +// (You can also execute it with `cargo run`, but you'll need to do some work before this will succeed.) // -// If you do not want to copy all the code yourself, and wish to start with my code and just edit -// it, you can copy the files from `src` in this repository, to `src` in your workspace copy. +// If you later want to update the course, do `git pull` (or re-download the zip archive). +// Then copy the files from `workspace/src/` to your workspace that you did not yet work on. Definitely +// copy `main.rs` to make sure all the new files are actually compiled. (Of course you can also +// copy the rest, but that would replace all your hard work by the original files with all the holes!) // Course Content // -------------- // -// The actual course is in the partXX.rs files. The part 00-03 cover some basic of the language, -// to give you a feeling for Rust's syntax and pervasive mechanisms like pattern matching and traits. -// Parts 04-06 introduce the heart of the language, the mechanism making it different from anything -// else out there: Ownership, borrowing, lifetimes. In part 07-??, we continue our tour through -// Rust. Finally, in parts ??-??, we implement our own version of `grep`, exhibiting useful Rust -// features as we go. -// -// You should start with [the first part](part00.html), or jump directly to where you left off: +// Open `your-workspace/src/part00.rs` in your favorite editor, and follow the link below for +// the explanations and exercises. You are ready to start. Have fun! // +// ### Introduction +// // * [Part 00: Algebraic datatypes](part00.html) // * [Part 01: Expressions, Inherent methods](part01.html) // * [Part 02: Generic types, Traits](part02.html) // * [Part 03: Input](part03.html) +// +// ### Basic Rust +// // * [Part 04: Ownership, Borrowing](part04.html) // * [Part 05: Clone](part05.html) // * [Part 06: Copy, Lifetimes](part06.html) // * [Part 07: Operator Overloading, Tests, Formating](part07.html) -// * (to be continued) -#![allow(dead_code, unused_imports, unused_variables, unused_mut)] +// * [Part 08: Associated Types, Modules](part08.html) +// * [Part 09: Iterators](part09.html) +// * [Part 10: Closures](part10.html) +// +// ### Advanced Rust +// +// * [Part 11: Trait Objects, Box, Lifetime bounds](part11.html) +// * [Part 12: Rc, Interior Mutability, Cell, RefCell](part12.html) +// * [Part 13: Concurrency, Arc, Send](part13.html) +// * [Part 14: Slices, Arrays, External Dependencies](part14.html) +// * [Part 15: Mutex, Interior Mutability (cont.), RwLock, Sync](part15.html) +// * [Part 16: Unsafe Rust, Drop](part16.html) +// +#![allow(dead_code, unused_imports, unused_variables, unused_mut, unreachable_code)] mod part00; mod part01; mod part02; @@ -90,14 +97,21 @@ mod part06; mod part07; mod part08; mod part09; +mod part10; +mod part11; +mod part12; +mod part13; +mod part14; +mod part15; +mod part16; // To actually run the code of some part (after filling in the blanks, if necessary), simply edit the `main` // function. - fn main() { part00::main(); } + // Additional material // ------------------- // @@ -106,5 +120,6 @@ fn main() { // // * [The Rust Book](https://doc.rust-lang.org/stable/book/) // * [Rust by Example](http://rustbyexample.com/) +// * [The Advanced Rust Programming Guide](http://cglab.ca/~abeinges/blah/turpl/_book/README.html) // * The [Rust Subreddit](https://www.reddit.com/r/rust/) // * For the IRC channel and other forums, see the "Community" section of the [Rust Documentation index](http://doc.rust-lang.org/index.html)