src/doc/rust-by-example/src/index.md

   1 # Rust by Example
   2
   3 [Rust][rust] is a modern systems programming language focusing on safety, speed,
   4 and concurrency. It accomplishes these goals by being memory safe without using
   5 garbage collection.
   6
   7 Rust by Example (RBE) is a collection of runnable examples that illustrate various Rust
   8 concepts and standard libraries. To get even more out of these examples, don't forget
   9 to [install Rust locally][install] and check out the [official docs][std].
  10 Additionally for the curious, you can also [check out the source code for this site][home].
  11
  12 Now let's begin!
  13
  14 - [Hello World](hello.md) - Start with a traditional Hello World program.
  15
  16 - [Primitives](primitives.md) - Learn about signed integers, unsigned integers and other primitives.
  17
  18 - [Custom Types](custom_types.md) - `struct` and `enum`.
  19
  20 - [Variable Bindings](variable_bindings.md) - mutable bindings, scope, shadowing.
  21
  22 - [Types](types.md) - Learn about changing and defining types.
  23
  24 - [Conversion](conversion.md)
  25
  26 - [Expressions](expression.md)
  27
  28 - [Flow of Control](flow_control.md) - `if`/`else`, `for`, and others.
  29
  30 - [Functions](fn.md) - Learn about Methods, Closures and High Order Functions.
  31
  32 - [Modules](mod.md) - Organize code using modules
  33
  34 - [Crates](crates.md) - A crate is a compilation unit in Rust. Learn to create a library.
  35
  36 - [Cargo](cargo.md) - Go through some basic features of the official Rust package management tool.
  37
  38 - [Attributes](attribute.md) - An attribute is metadata applied to some module, crate or item.
  39
  40 - [Generics](generics.md) - Learn about writing a function or data type which can work for multiple types of arguments.
  41
  42 - [Scoping rules](scope.md) - Scopes play an important part in ownership, borrowing, and lifetimes.
  43
  44 - [Traits](trait.md) - A trait is a collection of methods defined for an unknown type: `Self`
  45
  46 - [Macros](macros.md)
  47
  48 - [Error handling](error.md) - Learn Rust way of handling failures.
  49
  50 - [Std library types](std.md) - Learn about some custom types provided by `std` library.
  51
  52 - [Std misc](std_misc.md) - More custom types for file handling, threads.
  53
  54 - [Testing](testing.md) - All sorts of testing in Rust.
  55
  56 - [Unsafe Operations](unsafe.md)
  57
  58 - [Compatibility](compatibility.md)
  59
  60 - [Meta](meta.md) - Documentation, Benchmarking.
  61
  62
  63 [rust]: https://www.rust-lang.org/
  64 [install]: https://www.rust-lang.org/tools/install
  65 [std]: https://doc.rust-lang.org/std/
  66 [home]: https://github.com/rust-lang/rust-by-example