Use &mut self in FlatChainStore inner methods
#512
Merged
Conversation
This file contains hidden or 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
The methods that conceptually mutate the state (even if using raw pointers) should take `&mut self` to let the compiler enforce the ownership rules correctly. This way it will be harder for us to misuse the methods. We also get rid of the `#[allow(clippy::mut_from_ref)]`. The only exception is `BlockIndex.set_index_for_hash` (because we pass a `&self` closure to it). This should be fine as we only use it inside `add_index_entry`. Polished a bit the docstrings and fixed two conditional compilation warnings for Windows.
4f1c147 to
d7daffe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What is the purpose of this pull request?
Which crates are being modified?
Description
The methods that conceptually mutate the state (even if using raw pointers) should take
&mut selfto let the compiler enforce the ownership rules correctly. This way it will be harder for us to misuse the methods. We also get rid of the#[allow(clippy::mut_from_ref)].The only exception is
BlockIndex.set_index_for_hash(because we pass a&selfclosure to it). This should be fine as we only use it insideadd_index_entry.Polished a bit the docstrings and fixed two conditional compilation warnings for Windows.