Struct hyena::TaskPool

pub struct TaskPool { /* private fields */ }

A pool of threads for running Tasks.

Implementations

impl TaskPool

pub fn new() -> Result<Self>

Creates a new TaskPool using default settings.

pub fn global() -> &'static Self

Gets a reference to the global TaskPool.

Panics

Panics if the global TaskPool fails initialization, this should only happen if spawning the thread pool fails.

pub fn builder() -> TaskPoolBuilder

Creates a new TaskPoolBuilder.

Examples

let task_pool = TaskPool::builder()
    .num_threads(4)
    .stack_size(1024 * 1024)
    .thread_name("my-task-pool")
    .build()
    .expect("Failed to create task pool");

pub fn thread_count(&self) -> usize

Returns the number of threads in the pool.

pub fn spawn<T>( &self, future: impl Future<Output = T> + Send + 'static ) -> Task<T> where T: Send + 'static,

Spawns a Task in the thread pool.

pub fn spawn_local<T>( &self, future: impl Future<Output = T> + 'static ) -> Task<T> where T: 'static,

Spawns a Task in the thread local executor.

pub fn scope<'env, F, T>(&self, f: F) -> Vec<T>where F: for<'scope> FnOnce(&'scope Scope<'scope, 'env, T>), T: Send + 'static,

Allows spawning futures on the thread pool that aren’t 'static. The function takes a callback passing a Scope to it. The Scope can be used to spawn futures. This function will wait all futures spawned on the Scope to completion before returning.

Trait Implementations

impl Clone for TaskPool

fn clone(&self) -> TaskPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.