pub struct LocalPool { /* private fields */ }
Expand description
A single-threaded task pool.
This executor allows you to multiplex any number of tasks onto a single thread. It’s appropriate for strictly I/O-bound tasks that do very little work in between I/O actions.
To get a handle to the pool that implements
Executor
, use the
executor()
method. Because the executor is
single-threaded, it supports a special form of task spawning for non-Send
futures, via spawn_local
.
Implementations§
Source§impl LocalPool
impl LocalPool
Sourcepub fn executor(&self) -> LocalExecutor
pub fn executor(&self) -> LocalExecutor
Get a clonable handle to the pool as an executor.
Sourcepub fn run(&mut self, exec: &mut dyn Executor)
pub fn run(&mut self, exec: &mut dyn Executor)
Run all tasks in the pool to completion.
The given executor, exec
, is used as the default executor for any
newly-spawned tasks. You can route these additional tasks back into
the LocalPool
by using its executor handle:
let mut pool = LocalPool::new();
let mut exec = pool.executor();
// ... spawn some initial tasks using `exec.spawn()` or `exec.spawn_local()`
// run *all* tasks in the pool to completion, including any newly-spawned ones.
pool.run(&mut exec);
The function will block the calling thread until all tasks in the pool are complete, including any spawned while running existing tasks.
Sourcepub fn run_until<F>(
&mut self,
f: F,
exec: &mut dyn Executor,
) -> Result<<F as Future>::Item, <F as Future>::Error>where
F: Future,
pub fn run_until<F>(
&mut self,
f: F,
exec: &mut dyn Executor,
) -> Result<<F as Future>::Item, <F as Future>::Error>where
F: Future,
Runs all the tasks in the pool until the given future completes.
The given executor, exec
, is used as the default executor for any
newly-spawned tasks. You can route these additional tasks back into
the LocalPool
by using its executor handle:
let mut pool = LocalPool::new();
let mut exec = pool.executor();
// run tasks in the pool until `my_app` completes, by default spawning
// further tasks back onto the pool
pool.run_until(my_app, &mut exec);
The function will block the calling thread only until the future f
completes; there may still be incomplete tasks in the pool, which will
be inert after the call completes, but can continue with further use of
run
or run_until
. While the function is running, however, all tasks
in the pool will try to make progress.
Auto Trait Implementations§
impl Freeze for LocalPool
impl !RefUnwindSafe for LocalPool
impl !Send for LocalPool
impl !Sync for LocalPool
impl Unpin for LocalPool
impl !UnwindSafe for LocalPool
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more