Struct JxlThreadPool

pub struct JxlThreadPool(/* private fields */);

Thread pool wrapper.

This struct wraps internal thread pool implementation and provides interfaces to access it. If rayon feature is enabled, users can create an actual thread pool backed by Rayon; if not, this struct won’t have any multithreading capability, and every spawn operation will just run the given closure in place.

Implementations

impl JxlThreadPool

pub const fn none() -> JxlThreadPool

Creates a “fake” thread pool without any multithreading capability.

Every spawn operation on this thread poll will just run the closure in current thread.

pub fn with_rayon_thread_pool(pool: Arc<ThreadPool>) -> JxlThreadPool

Available on crate feature rayon only.

Creates a thread pool backed by Rayon ThreadPool.

pub fn rayon(num_threads_requested: Option<usize>) -> JxlThreadPool

Available on crate feature rayon only.

Creates a thread pool backed by Rayon.

If num_threads_requested is None or zero, this method queries available paralleism and uses it.

pub fn as_rayon_pool(&self) -> Option<&ThreadPool>

Available on crate feature rayon only.

Returns the reference to Rayon thread pool, if exists.

pub fn is_multithreaded(&self) -> bool

Returns if the thread pool is capable of multithreading.

impl JxlThreadPool

pub fn spawn(&self, op: impl FnOnce() + Send + 'static)

Runs the given closure on the thread pool.

pub fn scope<'scope, R>( &'scope self, op: impl for<'r> FnOnce(JxlScope<'r, 'scope>) -> R + Send, ) -> R

where R: Send,

Creates a fork-join scope of tasks.

pub fn for_each_vec<T>(&self, v: Vec<T>, op: impl Fn(T) + Send + Sync)

where T: Send,

Consumes the Vec, and runs a job for each element of the Vec.

pub fn for_each_vec_with<T, U>( &self, v: Vec<T>, init: U, op: impl Fn(&mut U, T) + Send + Sync, )

where T: Send, U: Send + Clone,

Consumes the Vec, and runs a job for each element of the Vec.

pub fn for_each_mut_slice<'a, T>( &self, v: &'a mut [T], op: impl Fn(&'a mut T) + Send + Sync, )

where T: Send,

Runs a job for each element of the mutable slice.

pub fn for_each_mut_slice_with<'a, T, U>( &self, v: &'a mut [T], init: U, op: impl Fn(&mut U, &'a mut T) + Send + Sync, )

where T: Send, U: Send + Clone,

Runs a job for each element of the mutable slice.

Trait Implementations

impl Clone for JxlThreadPool

fn clone(&self) -> JxlThreadPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JxlThreadPool

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

Formats the value using the given formatter.