Remove overloaded public methods from X509IdentityProvider #236
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
mgeisler
force-pushed
the
x509-identity-provider-less-public-methods
branch
from
4854a94 to
7f7cd2c
Compare
While using a `X509IdentityProvider` in a generic context, I discovered that it has a few methods which I found confusing: - X509IdentityProvider::identity takes 1 argument, but IdentityProvider::identity takes 2 arguments! - X509IdentityProvider::valid_successor takes 2 arguments, but IdentityProvider::valid_successor takes 3 arguments! I ended up solving this with the fully-qualified `<Type as Trait>::method` syntax, but I think the situation can be avoided all together by just implementing the trait directly.
The previous commit removed a few public methods, implying that we need a SemVer breaking change. Since the types are re-exported in mls-rs, I also bumped the version of that crate.
mgeisler
force-pushed
the
x509-identity-provider-less-public-methods
branch
from
7f7cd2c to
825ca0e
Compare
mgeisler
changed the title
|
The "Native / LintAndFormatting (pull_request)" failure seems unrelated — it's about an unexpected lint, which became a warning recently. |
|
I fixed the warnings in #237 - we only fixed them on 1.x-main and forgot main |
mulmarta
approved these changes
Jan 14, 2025
Thanks for merging the fix back! I should have done that, but got distracted today 😄 |
tomleavy
approved these changes
Jan 14, 2025
|
By the way, do you plan on merging the |
|
Yeah that's the idea. Once we have enough for alpha 1 we will merge and create a branch off right before that for bug fixes on 0.x |
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 of changes:
While using a
X509IdentityProviderin a generic context, I discovered that it has a few methods which I found confusing:X509IdentityProvider::identitytakes 1 argument, butIdentityProvider::identitytakes 2 arguments!X509IdentityProvider::valid_successortakes 2 arguments, butIdentityProvider::valid_successortakes 3 arguments!I ended up solving this with the fully-qualified
<Type as Trait>::methodsyntax, but I think the situation can be avoided all together by just implementing the trait directly.Please let me know what you think of this — I think it's simpler without the "double" implementations, but perhaps I'm missing something.
Call-outs:
This is a SemVer breaking change, so I've bumped the version number of mls-rs-identity-x509. Since the type is re-exported by mls-rs, I bumped its version number as well.
Testing:
Tests we updated to pass in the necessary parameters, even though we know they are not used in the tests.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT license.