refactor(iroh-bytes): Simplify store traits #2023
Merged
Conversation
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
(e.g. when ipv6 stun can't be sent)
PartialMap -> MapMut PartialEntry -> EntryMut
rklaehn
force-pushed
the
simplify-store-triat
branch
from
d9ea292 to
bee6d19
Compare
rklaehn
changed the title
rklaehn
force-pushed
the
simplify-store-triat
branch
from
bee6d19 to
8ef2bc3
Compare
# Conflicts: # iroh-net/src/netcheck/reportgen.rs
rklaehn
force-pushed
the
simplify-store-triat
branch
from
8ef2bc3 to
ebd58f5
Compare
in particular clarify what a Map is.
for now this is an enum with a size and verified/unverified. In the future we might add more info to the unverified path, such as the max offset we have validated. But this info is not always available easily, so we don't for now. If you just want the size value, there is .value().
dignifiedquire
approved these changes
Feb 20, 2024
Frando
approved these changes
Feb 20, 2024
There was a problem hiding this comment.
👍 Nothing stood out to me, apart from the already resolved question of whether we want to use RPITIT - where I think I agree with rklaehn's reasoning above that you usually will need lots of boilerplate or boxing anyways. And the code reads much nicer with the impl Trait than with the associated traits. So: LGTM!
fubuloubu
pushed a commit
to ApeWorX/iroh
that referenced
this pull request
Feb 21, 2024
## Description Simplify and rename some store traits, taking advantage of return position impl trait in trait. The main change is that the map entries are no longer for one specific map impl, but just generic map entries, so the type parameter goes away. Other than that, the PartialXXX traits are renamed to XXXMut, which is more accurate. An immutable entry can be partial. Since MapEntry does not guarantee that it is complete (anymore), the main difference between MapEntry and MapEntryMut is not that the latter allows writing. Edit: one additional change is to introduce BaoBlobSize, which is a size together with an information about whether the size is validated or not. Why not just (u64, bool)? Because later we might add more info to the unverified enum case. ## Notes & open questions Note: this is not the end of it. Just trying to do this incrementally. ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - [ ] Tests if relevant.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Simplify and rename some store traits, taking advantage of return position impl trait in trait.
The main change is that the map entries are no longer for one specific map impl, but just generic map entries, so the type parameter goes away. Other than that, the PartialXXX traits are renamed to XXXMut, which is more accurate. An immutable entry can be partial. Since MapEntry does not guarantee that it is complete (anymore), the main difference between MapEntry and MapEntryMut is not that the latter allows writing.
Edit: one additional change is to introduce BaoBlobSize, which is a size together with an information about whether the size is validated or not. Why not just (u64, bool)? Because later we might add more info to the unverified enum case.
Notes & open questions
Note: this is not the end of it. Just trying to do this incrementally.
Change checklist