feat(iroh-relay)!: adjust APIs to make it easier to create RelayMaps from lists of RelayUrls
#3292
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
… from lists of `RelayUrls` In our examples and tests, it is enough to build `RelayMap`s from a single `RelayUrl`, but our users will more likely be in the situation where they have multiple relays. This changes the APIs to make adding multiple relays the most prominant use case.
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3292/docs/iroh/ Last updated: 2025-05-07T16:18:39Z |
ramfox
changed the title
RelayMaps from lists of RelayUrlsRelayMaps from lists of RelayUrls
ramfox
requested review from
flub,
dignifiedquire and
matheus23
and removed request for
flub and
dignifiedquire
|
I think it is great to be sleuthing at these APIs! They are indeed not very ergonomic. Would they not be more rusty by leveraging traits more?
I'm kind of curious why they grew into what they currently are, so might be missing the mark. Edit: The doc comments on all the functions are also fairly over the place and need fixing. |
|
Did everything suggested in @flub your comment, but adjusted the code to remove the need for the |
flub
reviewed
May 7, 2025
matheus23
reviewed
May 7, 2025
Co-authored-by: Floris Bruynooghe <[email protected]>
Co-authored-by: Floris Bruynooghe <[email protected]>
Co-authored-by: Floris Bruynooghe <[email protected]>
Co-authored-by: Floris Bruynooghe <[email protected]>
…t we also have a QUIC port to configure, having an impl that only looks at the STUN port does not make sense
flub
approved these changes
May 8, 2025
matheus23
approved these changes
May 8, 2025
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
In our examples and tests, it is enough to build
RelayMaps from a singleRelayUrl, but our users will more likely be in the situation where they have multiple relays.Now we have
From<RelayUrl>,From<(RelayUrl, u16)>,FromIterator<RelayUrl>FromIterator<(RelayUrl, u16)>impls to create aRelayMap.Also,
From<RelayUrl>andFrom<(RelayUrl, u16)>to create aRelayNode.Breaking Changes
pub fn default_from_node(url: RelayUrl, stun_port: u16) -> RelayMappub fn from_url(url: RelayUrl) -> RelayMap, useFrom<RelayUrl>insteadChange checklist