[−][src]Struct futures::executor::ThreadPool
A general-purpose thread pool for scheduling tasks that poll futures to completion.
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) -> <F as Future>::Output where
F: Future, [src]
F: Future,
Runs the given future with this thread pool as the default spawner 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 spawner 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 Debug for ThreadPool[src]
impl Clone for ThreadPool[src]
fn clone(&self) -> ThreadPool[src]
default fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl Drop for ThreadPool[src]
impl Spawn for ThreadPool[src]
fn spawn_obj(
&mut self,
future: FutureObj<'static, ()>
) -> Result<(), SpawnError>[src]
&mut self,
future: FutureObj<'static, ()>
) -> Result<(), SpawnError>
default fn status(&self) -> Result<(), SpawnError>[src]
Determines whether the executor is able to spawn new tasks. Read more
impl<'_> Spawn for &'_ ThreadPool[src]
Auto Trait Implementations
impl Send for ThreadPool
impl Sync for ThreadPool
Blanket Implementations
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
impl<T> From for T[src]
impl<T, U> Into for T where
U: From<T>, [src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T> Borrow for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized, [src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T[src]
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<Sp> SpawnExt for Sp where
Sp: Spawn + ?Sized, [src]
Sp: Spawn + ?Sized,
default fn spawn<Fut>(&mut self, future: Fut) -> Result<(), SpawnError> where
Fut: Future<Output = ()> + Send + 'static, [src]
Fut: Future<Output = ()> + Send + 'static,
Spawns a task that polls the given future with output () to completion. Read more
default fn spawn_with_handle<Fut>(
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + Send + 'static,
<Fut as Future>::Output: Send, [src]
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + Send + 'static,
<Fut as Future>::Output: Send,
Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future's output. Read more
ⓘImportant traits for Compat<R>default fn compat(self) -> Compat<Self>[src]
Wraps a [Spawn] and makes it usable as a futures 0.1 Executor. Requires the compat feature to enable. Read more