]> git.proxmox.com Git - rustc.git/blob - vendor/rustc-rayon-core/README.md
New upstream version 1.70.0+dfsg1
[rustc.git] / vendor / rustc-rayon-core / README.md
1 Note: This is an unstable fork made for use in rustc
2
3 Rayon-core represents the "core, stable" APIs of Rayon: join, scope, and so forth, as well as the ability to create custom thread-pools with ThreadPool.
4
5 Maybe worth mentioning: users are not necessarily intended to directly access rayon-core; all its APIs are mirror in the rayon crate. To that end, the examples in the docs use rayon::join and so forth rather than rayon_core::join.
6
7 rayon-core aims to never, or almost never, have a breaking change to its API, because each revision of rayon-core also houses the global thread-pool (and hence if you have two simultaneous versions of rayon-core, you have two thread-pools).
8
9 Please see [Rayon Docs] for details about using Rayon.
10
11 [Rayon Docs]: https://docs.rs/rayon/
12
13 Rayon-core currently requires `rustc 1.59.0` or greater.