-
Notifications
You must be signed in to change notification settings - Fork 381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding 'clone to satisfy the borrow checker' anti-pattern #23
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Clone to satisfy the borrow checker | ||
|
||
## Description | ||
|
||
The borrow checker prevents Rust users from developing otherwise unsafe code by | ||
ensuring that either: only one mutable reference exists, or potentially many but | ||
all immutable references exist. If the code written does not hold true to these | ||
conditions, this anti-pattern arises when the developer resolves the compiler | ||
error by cloning the variable. | ||
|
||
|
||
## Example | ||
|
||
```rust | ||
// define any variable | ||
let mut x = 5; | ||
|
||
// Borrow `x` -- but clone it first | ||
let y = &mut (x.clone()); | ||
|
||
// perform some action on the borrow to prevent rust from optimizing this | ||
//out of existence | ||
*y += 1; | ||
|
||
// without the x.clone() two lines prior, this line would fail on compile as | ||
// x has been borrowed | ||
// thanks to x.clone(), x was never borrowed, and this line will run. | ||
println!("{}", x); | ||
``` | ||
|
||
|
||
## Motivation | ||
|
||
It is tempting, particularly for beginners, to use this pattern to resolve | ||
confusing issues with the borrow checker. However, there are serious | ||
consequences. Using .clone() causes a copy of the data to be made. Any changes | ||
between the two are not synchronized -- as if two completely separate variables | ||
exist. | ||
|
||
There are special cases -- `Rc<T>` is designed to handle clones intelligently. | ||
It internally manages exactly one copy of the data, and cloning it will only | ||
clone the reference. | ||
|
||
In general, clones should be deliberate, with full understanding of the | ||
consequences. If a clone is used to make a borrow checker error disappear, | ||
that's a good indication this anti-pattern may be in use. | ||
|
||
If an unnecessary clone is suspected, The Rust Book's chapter on Ownership | ||
should be understood fully before assessing whether the clone is required or not. | ||
|
||
|
||
## See also | ||
|
||
[The Rust Book: Ownership, which describes how the borrow checker behaves](https://doc.rust-lang.org/book/ownership.html) | ||
[Rc<T> documentation, which handles .clone() intelligently](http://doc.rust-lang.org/std/rc/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can come up with a better example; I'm not sure if this is really a problem when your type is copy. Let me play around with some examples and get back to you.