Improve diagnostics for depracted Lock.
#2285
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
Motivation: When using a `Lock` instance handed by another library and calling `withLock` or `withLockVoid` on it, the compiler will issue an incorrect fix-it warning that `withLock` (or `withLockVoid`) was renamed to `NIOLock`. Modifications: The warning results from annotating the extension that adds `withLock` and `withLockVoid` with `@available(*, deprecated, renamed: "NIOLock")`. This removes the annotation and moves these two methods into the main declaration of `Lock`. Result: The fix-it warning no longer appears when using `withLock` or `withLockVoid`.
|
Can one of the admins verify this patch? |
10 similar comments
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Hmm, @swift-server-bot seems to be a bit of an overachiever... 😄 |
Lukasa
approved these changes
Oct 7, 2022
|
@swift-server-bot test this please |
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.
Improve diagnostics for depracted
Lock.Motivation:
When using a
Lockinstance handed by another library and callingwithLockorwithLockVoidon it, the compiler will issue an incorrect fix-it warning thatwithLock(orwithLockVoid) was renamed toNIOLockand by applying it will incorrectly change the method signature toNIOLock.For example when using Vapor, there is a property called
lockson Vapor'sApplicationclass. Vapors hands out locks to users here. However, creating these locks isn't done by the users of Vapor, but by Vapor itself. Thus, users cannot fix the deprecation themselves.Modifications:
The warning results from annotating the extension that adds
withLockandwithLockVoidwith@available(*, deprecated, renamed: "NIOLock"). This removes the annotation and moves these two methods into the main declaration ofLock.Result:
The fix-it warning no longer appears when using
withLockorwithLockVoid.