Struct bevy_tasks::IoTaskPool
source · pub struct IoTaskPool(/* private fields */);
Expand description
A newtype for a task pool for IO-intensive work (i.e. tasks that spend very little time in a “woken” state)
See TaskPool
documentation for details on Bevy tasks.
Implementations§
source§impl IoTaskPool
impl IoTaskPool
sourcepub fn get_or_init(f: impl FnOnce() -> TaskPool) -> &'static Self
pub fn get_or_init(f: impl FnOnce() -> TaskPool) -> &'static Self
Gets the global IoTaskPool
instance, or initializes it with f
.
sourcepub fn try_get() -> Option<&'static Self>
pub fn try_get() -> Option<&'static Self>
Attempts to get the global IoTaskPool
instance, or returns None
if it is not initialized.
sourcepub fn get() -> &'static Self
pub fn get() -> &'static Self
Gets the global IoTaskPool
instance.
§Panics
Panics if the global instance has not been initialized yet.
Methods from Deref<Target = TaskPool>§
sourcepub fn thread_num(&self) -> usize
pub fn thread_num(&self) -> usize
Return the number of threads owned by the task pool
sourcepub fn scope<'env, F, T>(&self, f: F) -> Vec<T>
pub fn scope<'env, F, T>(&self, f: F) -> Vec<T>
Allows spawning non-'static
futures on the thread pool. The function takes a callback,
passing a scope object into it. The scope object provided to the callback can be used
to spawn tasks. This function will await the completion of all tasks before returning.
This is similar to rayon::scope
and crossbeam::scope
sourcepub fn scope_with_executor<'env, F, T>(
&self,
_tick_task_pool_executor: bool,
_thread_executor: Option<&ThreadExecutor<'_>>,
f: F
) -> Vec<T>
pub fn scope_with_executor<'env, F, T>( &self, _tick_task_pool_executor: bool, _thread_executor: Option<&ThreadExecutor<'_>>, f: F ) -> Vec<T>
Allows spawning non-'static
futures on the thread pool. The function takes a callback,
passing a scope object into it. The scope object provided to the callback can be used
to spawn tasks. This function will await the completion of all tasks before returning.
This is similar to rayon::scope
and crossbeam::scope
sourcepub fn spawn<T>(&self, future: impl Future<Output = T> + 'static) -> FakeTaskwhere
T: 'static,
pub fn spawn<T>(&self, future: impl Future<Output = T> + 'static) -> FakeTaskwhere
T: 'static,
Spawns a static future onto the thread pool. The returned Task is a future. It can also be cancelled and “detached” allowing it to continue running without having to be polled by the end-user.
If the provided future is non-Send
, TaskPool::spawn_local
should be used instead.
sourcepub fn spawn_local<T>(
&self,
future: impl Future<Output = T> + 'static
) -> FakeTaskwhere
T: 'static,
pub fn spawn_local<T>(
&self,
future: impl Future<Output = T> + 'static
) -> FakeTaskwhere
T: 'static,
Spawns a static future on the JS event loop. This is exactly the same as TaskPool::spawn
.
sourcepub fn with_local_executor<F, R>(&self, f: F) -> Rwhere
F: FnOnce(&LocalExecutor<'_>) -> R,
pub fn with_local_executor<F, R>(&self, f: F) -> Rwhere
F: FnOnce(&LocalExecutor<'_>) -> R,
Runs a function with the local executor. Typically used to tick the local executor on the main thread as it needs to share time with other things.
use bevy_tasks::TaskPool;
TaskPool::new().with_local_executor(|local_executor| {
local_executor.try_tick();
});