You've already forked comprehensive-rust
mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-07-14 10:04:19 +02:00
Comprehensive Rust v2 (#1073)
I've taken some work by @fw-immunant and others on the new organization of the course and condensed it into a form amenable to a text editor and some computational analysis. You can see the inputs in `course.py` but the interesting bits are the output: `outline.md` and `slides.md`. The idea is to break the course into more, smaller segments with exercises at the ends and breaks in between. So `outline.md` lists the segments, their duration, and sums those durations up per-day. It shows we're about an hour too long right now! There are more details of the segments in `slides.md`, or you can see mostly the same stuff in `course.py`. This now contains all of the content from the v1 course, ensuring both that we've covered everything and that we'll have somewhere to redirect every page. Fixes #1082. Fixes #1465. --------- Co-authored-by: Nicole LeGare <dlegare.1001@gmail.com> Co-authored-by: Martin Geisler <mgeisler@google.com>
This commit is contained in:
committed by
GitHub
parent
ea204774b6
commit
6d19292f16
80
src/methods-and-traits/methods.md
Normal file
80
src/methods-and-traits/methods.md
Normal file
@ -0,0 +1,80 @@
|
||||
---
|
||||
minutes: 10
|
||||
---
|
||||
|
||||
# Methods
|
||||
|
||||
Rust allows you to associate functions with your new types. You do this with an
|
||||
`impl` block:
|
||||
|
||||
```rust,editable
|
||||
#[derive(Debug)]
|
||||
struct Race {
|
||||
name: String,
|
||||
laps: Vec<i32>,
|
||||
}
|
||||
|
||||
impl Race {
|
||||
fn new(name: &str) -> Self { // No receiver, a static method
|
||||
Race { name: String::from(name), laps: Vec::new() }
|
||||
}
|
||||
|
||||
fn add_lap(&mut self, lap: i32) { // Exclusive borrowed read-write access to self
|
||||
self.laps.push(lap);
|
||||
}
|
||||
|
||||
fn print_laps(&self) { // Shared and read-only borrowed access to self
|
||||
println!("Recorded {} laps for {}:", self.laps.len(), self.name);
|
||||
for (idx, lap) in self.laps.iter().enumerate() {
|
||||
println!("Lap {idx}: {lap} sec");
|
||||
}
|
||||
}
|
||||
|
||||
fn finish(self) { // Exclusive ownership of self
|
||||
let total = self.laps.iter().sum::<i32>();
|
||||
println!("Race {} is finished, total lap time: {}", self.name, total);
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let mut race = Race::new("Monaco Grand Prix");
|
||||
race.add_lap(70);
|
||||
race.add_lap(68);
|
||||
race.print_laps();
|
||||
race.add_lap(71);
|
||||
race.print_laps();
|
||||
race.finish();
|
||||
// race.add_lap(42);
|
||||
}
|
||||
```
|
||||
|
||||
The `self` arguments specify the "receiver" - the object the method acts on. There
|
||||
are several common receivers for a method:
|
||||
|
||||
* `&self`: borrows the object from the caller using a shared and immutable
|
||||
reference. The object can be used again afterwards.
|
||||
* `&mut self`: borrows the object from the caller using a unique and mutable
|
||||
reference. The object can be used again afterwards.
|
||||
* `self`: takes ownership of the object and moves it away from the caller. The
|
||||
method becomes the owner of the object. The object will be dropped (deallocated)
|
||||
when the method returns, unless its ownership is explicitly
|
||||
transmitted. Complete ownership does not automatically mean mutability.
|
||||
* `mut self`: same as above, but the method can mutate the object.
|
||||
* No receiver: this becomes a static method on the struct. Typically used to
|
||||
create constructors which are called `new` by convention.
|
||||
|
||||
<details>
|
||||
|
||||
Key Points:
|
||||
* It can be helpful to introduce methods by comparing them to functions.
|
||||
* Methods are called on an instance of a type (such as a struct or enum), the first parameter represents the instance as `self`.
|
||||
* Developers may choose to use methods to take advantage of method receiver syntax and to help keep them more organized. By using methods we can keep all the implementation code in one predictable place.
|
||||
* Point out the use of the keyword `self`, a method receiver.
|
||||
* Show that it is an abbreviated term for `self: Self` and perhaps show how the struct name could also be used.
|
||||
* Explain that `Self` is a type alias for the type the `impl` block is in and can be used elsewhere in the block.
|
||||
* Note how `self` is used like other structs and dot notation can be used to refer to individual fields.
|
||||
* This might be a good time to demonstrate how the `&self` differs from `self` by trying to run `finish` twice.
|
||||
* Beyond variants on `self`, there are also [special wrapper types](https://doc.rust-lang.org/reference/special-types-and-traits.html) allowed to be receiver types, such as `Box<Self>`.
|
||||
* Note that references have not been covered yet. References in method receivers are a particularly "natural" form of reference, so there is no need to go into a great level of detail.
|
||||
|
||||
</details>
|
Reference in New Issue
Block a user