rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-06-12 20:37:32 +02:00
Code Issues Releases Activity

Update receiver.md (#229)

Browse Source 
The key takeaway is mutability of receivers and the rules that come with it. It might be a repetition of borrow checker rules, but it is important to know they apply to `self` as to any other variable or argument.
This commit is contained in:
Igor Petruk 2023-01-23 11:39:38 +00:00 committed by GitHub
parent c109dabf5f
commit ef119bc0d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/methods/receiver.md
View File

@ -11,9 +11,19 @@ are other possible receivers for a method:
method becomes the owner of the object. The object will be dropped (deallocated) method becomes the owner of the object. The object will be dropped (deallocated)
when the method returns, unless its ownership is explicitly when the method returns, unless its ownership is explicitly
transmitted. transmitted.
* `mut self`: same as above, but while the method owns the object, it can
mutate it too. Complete ownership does not automatically mean mutability.
* No receiver: this becomes a static method on the struct. Typically used to * No receiver: this becomes a static method on the struct. Typically used to
create constructors which are called `new` by convention. create constructors which are called `new` by convention.
Beyond variants on `self`, there are also Beyond variants on `self`, there are also
[special wrapper types](https://doc.rust-lang.org/reference/special-types-and-traits.html) [special wrapper types](https://doc.rust-lang.org/reference/special-types-and-traits.html)
allowed to be receiver types, such as `Box<Self>`. allowed to be receiver types, such as `Box<Self>`.
<details>
Consider emphasizing on "shared and immutable" and "unique and mutable". These constraints always come
together in Rust due to borrow checker rules, and `self` is no exception. It won't be possible to
reference a struct from multiple locations and call a mutating (`&mut self`) method on it.
</details>