Struct BlockingTaskPool

pub struct BlockingTaskPool { /* private fields */ }

Available on crate feature rayon only.

Used to execute blocking tasks on a rayon threadpool from within a tokio runtime.

This is a dedicated threadpool for blocking tasks which are CPU bound. RPC calls that perform blocking IO (disk lookups) are not executed on this pool but on the tokio runtime’s blocking pool, which performs poorly with CPU bound tasks (see https://ryhl.io/blog/async-what-is-blocking/). Once the tokio blocking pool is saturated it is converted into a queue, blocking tasks could then interfere with the queue and block other RPC calls.

See also tokio-docs for more information.

Implementations

impl BlockingTaskPool

pub fn new(pool: ThreadPool) -> Self

Create a new BlockingTaskPool with the given threadpool.

pub fn builder() -> ThreadPoolBuilder

Convenience function to start building a new threadpool.

pub fn build() -> Result<Self, ThreadPoolBuildError>

Convenience function to build a new threadpool with the default configuration.

Uses rayon::ThreadPoolBuilder::build defaults but increases the stack size to 8MB.

pub fn spawn<F, R>(&self, func: F) -> BlockingTaskHandle<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Asynchronous wrapper around Rayon’s ThreadPool::spawn.

Runs a function on the configured threadpool, returning a future that resolves with the function’s return value.

If the function panics, the future will resolve to an error.

pub fn spawn_fifo<F, R>(&self, func: F) -> BlockingTaskHandle<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Asynchronous wrapper around Rayon’s ThreadPool::spawn_fifo.

Runs a function on the configured threadpool, returning a future that resolves with the function’s return value.

If the function panics, the future will resolve to an error.

Trait Implementations

impl Clone for BlockingTaskPool

fn clone(&self) -> BlockingTaskPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockingTaskPool

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes