This repository has been archived by the owner on Oct 17, 2024. It is now read-only.
Make isComplete reflect result availability #178
Merged
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
Fixes #176 Change the `CancelableOperation.isComplete` to forward to the `_inner` completer, which is not completed until the result is available unlike `CancelableOperation.isComplete` which may lead the result when `complete` is called with a `Future` argument. Update the docs to reflect the new behavior. Keep the detail about this property indicating whether the operation can still be canceled. This detail was incorrectly stated before, but matches the new implementation. Remove details pointing to `CancelableCompleter` from the `CancelableOperation` docs. Flesh out the docs on the completer so that the distinction between the two `isComplete` getters is more clear. Remove a detail about not returning `null` from the `cancel()` doc since the non-nullable return type already makes this clear.
lrhn
approved these changes
May 10, 2021
mosuem
pushed a commit
to dart-lang/core
that referenced
this pull request
Oct 14, 2024
Fixes dart-lang/async#176 Change the `CancelableOperation.isComplete` to forward to the `_inner` completer, which is not completed until the result is available unlike `CancelableOperation.isComplete` which may lead the result when `complete` is called with a `Future` argument. Update the docs to reflect the new behavior. Keep the detail about this property indicating whether the operation can still be canceled. This detail was incorrectly stated before, but matches the new implementation. Remove details pointing to `CancelableCompleter` from the `CancelableOperation` docs. Flesh out the docs on the completer so that the distinction between the two `isComplete` getters is more clear. Remove a detail about not returning `null` from the `cancel()` doc since the non-nullable return type already makes this clear.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes dart-lang/core#341
Change the
CancelableOperation.isCompleteto forward to the_innercompleter, which is not completed until the result is available unlike
CancelableOperation.isCompletewhich may lead the result whencompleteis called with aFutureargument. Update the docs toreflect the new behavior. Keep the detail about this property indicating
whether the operation can still be canceled. This detail was incorrectly
stated before, but matches the new implementation.
Remove details pointing to
CancelableCompleterfrom theCancelableOperationdocs. Flesh out the docs on the completer so thatthe distinction between the two
isCompletegetters is more clear.Remove a detail about not returning
nullfrom thecancel()doc sincethe non-nullable return type already makes this clear.