[docs] the ThreadPool
struct in rayon-core
needs documentation
#235
Labels
Milestone
ThreadPool
struct in rayon-core
needs documentation
#235
The
ThreadPool
struct represents a user created thread-pool (as opposed to the default, global threadpool). It needs/// foo
docs.Some things to say:
ThreadPool::new
(!). You can use the configuration to specify the number or names of its threads, how to handle uncaptured panics, and so forth.ThreadPool::install()
. This will execute a closure in one of the threadpool's threads. Any other Rayon operations -- like parallel iterators,join()
, orscope()
-- will then execute in the context of this thread-pool.ThreadPool::spawn_async()
orThreadPool::spawn_future_async()
. These methods will inject jobs into the thread-pool that are not tied to your current stack frame; however, those jobs cannot access data owned by the stack.The text was updated successfully, but these errors were encountered: