feat(maitake-sync): rename EnqueueWait to Subscribe
#481
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
`maitake-sync`'s `waitmap::Wait' future has an `enqueue` method that does the same thing as the `subscribe` methods on `WaitCell` and `WaitQueue`...but has a different name. I think this might be due to `enqueue` being added earlier or something, or maybe we just weren't paying attention. Regardless, I figured it was nicer to use the same name for the method that does the same thing on these different types. This commit renames the `waitmap::Wait::enqueue` method to `subscribe`, and the future it returns from `EnqueueWait` to `Subscribe`, analogously to `WaitQueue` and `WaitCell`. I've left a deprecated type alias and a deprecated function alias in place, so this isn't a breaking change: users who reference `Wait::enqueue` or `EnqueueWait` will still be able to compile their code, but they'll get a warning. cc @jamesmunns, since I believe you added this API?
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.
maitake-sync'swaitmap::Waitfuture has anenqueuemethod thatdoes the same thing as the
subscribemethods onWaitCellandWaitQueue...but has a different name. I think this might be due toenqueuebeing added earlier or something, or maybe we just weren'tpaying attention. Regardless, I figured it was nicer to use the same
name for the method that does the same thing on these different types.
This commit renames the
waitmap::Wait::enqueuemethod tosubscribe,and the future it returns from
EnqueueWaittoSubscribe, analogouslyto
WaitQueueandWaitCell. I've left a deprecated type alias and adeprecated function alias in place, so this isn't a breaking change:
users who reference
Wait::enqueueorEnqueueWaitwill still be ableto compile their code, but they'll get a warning.
cc @jamesmunns, since I believe you added this API?