Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Point out cancelation semantics in fromCompletableFuture scaladoc #3644

Merged
merged 1 commit into from
May 25, 2023
Merged

Point out cancelation semantics in fromCompletableFuture scaladoc #3644

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions kernel/jvm/src/main/scala/cats/effect/kernel/AsyncPlatform.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ private[kernel] trait AsyncPlatform[F[_]] extends Serializable { this: Async[F]
/**
* Suspend a `java.util.concurrent.CompletableFuture` into the `F[_]` context.
*
* @note
* Cancelation is cooperative and it is up to the `CompletableFuture` to respond to the
* request by handling cancelation appropriately and indicating that it has done so. This
* means that if the `CompletableFuture` indicates that it did not cancel, there will be no
* "fire-and-forget" semantics. Instead, to satisfy backpressure guarantees, the
* `CompletableFuture` will be treated as if it is uncancelable and the fiber will fallback
* to waiting for it to complete.
*
* @param fut
* The `java.util.concurrent.CompletableFuture` to suspend in `F[_]`
*/
Expand Down