refactor(iroh-net)!: Do not use &NodeId in APIs as this is Copy #2363
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
Some of our APIs take NodeId by reference, some by value. NodeId itself however is Copy and takes 32 bytes. I think it is more consistent and rusty to pass this by value and use the Copy semantics. Additionally this renames a few more types from PublicKey to NodeId to keep in line with our convention of using NodeId when used as identifier rather than cryptography. I believe rust-analyser might be inserting PublicKey by itself which is unfortunate. QuicMappedAddr and IpPort are also a Copy types and get the same treatment.
dignifiedquire
approved these changes
Jun 14, 2024
ppodolsky
pushed a commit
to izihawa/iroh
that referenced
this pull request
Jun 22, 2024
…omputer#2363) ## Description Some of our APIs take NodeId by reference, some by value. NodeId itself however is Copy and takes 32 bytes. I think it is more consistent and rusty to pass this by value and use the Copy semantics. Additionally this renames a few more types from PublicKey to NodeId to keep in line with our convention of using NodeId when used as identifier rather than cryptography. I believe rust-analyser might be inserting PublicKey by itself which is unfortunate. QuicMappedAddr and IpPort are also a Copy types and get the same treatment. ## Breaking Changes - Endpoint::conn_type_stream takes NodeId by value instead of by reference. ## Notes & open questions <!-- Any notes, remarks or open questions you have to make about the PR. --> ## Change checklist - [x] Self-review. - ~~[ ] Documentation updates if relevant.~~ - ~~[ ] Tests if relevant.~~ - [x] All breaking changes documented.
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
Some of our APIs take NodeId by reference, some by value. NodeId
itself however is Copy and takes 32 bytes. I think it is more
consistent and rusty to pass this by value and use the Copy semantics.
Additionally this renames a few more types from PublicKey to NodeId to
keep in line with our convention of using NodeId when used as
identifier rather than cryptography. I believe rust-analyser might be
inserting PublicKey by itself which is unfortunate.
QuicMappedAddr and IpPort are also a Copy types and get the same
treatment.
Breaking Changes
Notes & open questions
Change checklist
[ ] Documentation updates if relevant.[ ] Tests if relevant.