[−][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]
impl ThreadPool
pub fn new() -> Result<ThreadPool, Error>
[src]
pub fn new() -> Result<ThreadPool, Error>
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]
pub fn builder() -> ThreadPoolBuilder
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]
pub fn run<F>(&mut self, f: F) -> <F as Future>::Output where
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 Clone for ThreadPool
[src]
impl Clone for ThreadPool
fn clone(&self) -> ThreadPool
[src]
fn clone(&self) -> ThreadPool
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Drop for ThreadPool
[src]
impl Drop for ThreadPool
impl Spawn for ThreadPool
[src]
impl Spawn for ThreadPool
fn spawn_obj(
&mut self,
future: FutureObj<'static, ()>
) -> Result<(), SpawnError>
[src]
fn spawn_obj(
&mut self,
future: FutureObj<'static, ()>
) -> Result<(), SpawnError>
Spawns a future that will be run to completion. Read more
fn status(&self) -> Result<(), SpawnError>
[src]
fn status(&self) -> Result<(), SpawnError>
Determines whether the executor is able to spawn new tasks. Read more
impl Debug for ThreadPool
[src]
impl Debug for ThreadPool
Auto Trait Implementations
impl Send for ThreadPool
impl Send for ThreadPool
impl Sync for ThreadPool
impl Sync for ThreadPool
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<Sp> SpawnExt for Sp where
Sp: Spawn + ?Sized,
[src]
impl<Sp> SpawnExt for Sp where
Sp: Spawn + ?Sized,
fn spawn<Fut>(&mut self, future: Fut) -> Result<(), SpawnError> where
Fut: Future<Output = ()> + Send + 'static,
[src]
fn spawn<Fut>(&mut self, future: Fut) -> Result<(), SpawnError> where
Fut: Future<Output = ()> + Send + 'static,
Spawns a task that polls the given future with output ()
to completion. Read more
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]
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,
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>fn compat(self) -> Compat<Self>
[src]
fn compat(self) -> Compat<Self>
Wraps a [Spawn
] and makes it usable as a futures 0.1 Executor
. Requires the compat
feature to enable. Read more