Struct bevy_tasks::TaskPoolBuilder

pub struct TaskPoolBuilder { /* private fields */ }

Used to create a TaskPool

Implementations

impl TaskPoolBuilder

pub fn new() -> Self

Creates a new TaskPoolBuilder instance

pub fn num_threads(self, num_threads: usize) -> Self

Override the number of threads created for the pool. If unset, we default to the number of logical cores of the system

pub fn stack_size(self, stack_size: usize) -> Self

Override the stack size of the threads created for the pool

pub fn thread_name(self, thread_name: String) -> Self

Override the name of the threads created for the pool. If set, threads will be named <thread_name> (<thread_index>), i.e. MyThreadPool (2)

pub fn on_thread_spawn(self, f: impl Fn() + Send + Sync + 'static) -> Self

Sets a callback that is invoked once for every created thread as it starts.

This is called on the thread itself and has access to all thread-local storage. This will block running async tasks on the thread until the callback completes.

pub fn on_thread_destroy(self, f: impl Fn() + Send + Sync + 'static) -> Self

Sets a callback that is invoked once for every created thread as it terminates.

This is called on the thread itself and has access to all thread-local storage. This will block thread termination until the callback completes.

pub fn build(self) -> TaskPool

Creates a new TaskPool based on the current options.

Trait Implementations

impl Default for TaskPoolBuilder

fn default() -> TaskPoolBuilder

Returns the “default value” for a type.