Struct futures::executor::ThreadPool
[−]
[src]
pub struct ThreadPool { /* fields omitted */ }
A general-purpose thread pool for scheduling asynchronous tasks.
The thread pool multiplexes any number of tasks onto a fixed number of worker threads.
This type is a clonable handle to the threadpool itself. Cloning it will only create a new reference, not a new threadpool.
Methods
impl ThreadPool
[src]
pub fn new() -> Result<ThreadPool, Error>
[src]
Creates a new thread pool with the default configuration.
See documentation for the methods in
ThreadPoolBuilder
for details on the default
configuration.
pub fn builder() -> ThreadPoolBuilder
[src]
Create a default thread pool configuration, which can then be customized.
See documentation for the methods in
ThreadPoolBuilder
for details on the default
configuration.
pub fn run<F>(
&mut self,
f: F
) -> Result<<F as Future>::Item, <F as Future>::Error> where
F: Future,
[src]
&mut self,
f: F
) -> Result<<F as Future>::Item, <F as Future>::Error> where
F: Future,
Runs the given future with this thread pool as the default executor for spawning tasks.
This function will block the calling thread until the given future is complete. While executing that future, any tasks spawned onto the default executor will be routed to this thread pool.
Note that the function will return when the provided future completes, even if some of the tasks it spawned are still running.
Trait Implementations
impl Executor for ThreadPool
[src]
fn spawn(
&mut self,
f: Box<Future<Error = Never, Item = ()> + 'static + Send>
) -> Result<(), SpawnError>
[src]
&mut self,
f: Box<Future<Error = Never, Item = ()> + 'static + Send>
) -> Result<(), SpawnError>
Spawn the given task, polling it until completion. Read more
fn status(&self) -> Result<(), SpawnError>
[src]
Determine whether the executor is able to spawn new tasks. Read more
impl Drop for ThreadPool
[src]
impl Debug for ThreadPool
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl Clone for ThreadPool
[src]
fn clone(&self) -> ThreadPool
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more