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.

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

Make jvmInterruptible public #73

Merged
merged 1 commit into from
May 15, 2024

Conversation

natsukagami
Copy link
Contributor

Fixes #71. Also added some documentation.

* operations such as `.await`) *and* [[java.lang.InterruptedException]], so the intended use case is usually to wrap
* interruptible Java operations, containing `fn` to a narrow scope.
*/
def jvmInterruptible[T](fn: => T)(using Async): T =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as this method is alread inside the JvmAsyncOperations, why it's not been named interruptible?
on unsupported platform, which can be just a noop.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already don't compile this function on an unsupported platform. I usually don't like the idea that we expose a function that sounds like it does something but is actually a no-op underneath 😓

We could call this function interruptible since it's already under JvmAsyncOperations, but I think it might be confused with the uninterruptible function that we do have outside.
They also take the same argument types, to add to the fire :)

@natsukagami natsukagami merged commit 9b0f350 into lampepfl:main May 15, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need jvmInterruptible to be public
2 participants