-
Notifications
You must be signed in to change notification settings - Fork 506
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
[docs] the spawn_future
method needs documentation
#234
Comments
Some usage examples would also be helpful. |
@lilianmoraru yes. I'd like to know the answer too. =P I've been refactoring the support for futures in rayon anyhow (rather slowly), once that's done I'll try to write-up some docs. |
Removing from the milestone since this is not part of the 1.0 API. |
@nikomatsakis is |
Bump, is there any chance we can get this feature back again? Currently using crossbeam's |
792: Removed outdated documentation r=cuviper a=kmaork `spawn_future()` doesn't exist anymore, so this commit removed a reference to it from the documentation. This closes #234 Co-authored-by: Maor Kleinberger <[email protected]>
The
Scope::spawn_future()
method is currently undocumented and needs/// foo
documentation. The documentation should probably be fairly similar toScope::spawn()
, but there are some things to note:RayonFuture
) that can be used to access that result.spawn_future()
is intended for computing values asynchronously, and not for side-effecting tasks.spawn()
is better if you have side-effects you wish to observe.Future::and_then()
. However, you may also invokeRayonFuture::rayon_wait()
on the returned future, which will block for the value. InvokingFuture::wait()
from inside a Rayon thread may cause deadlocks or panics and is not recommended.The text was updated successfully, but these errors were encountered: