Struct RayonExecutorService 

pub struct RayonExecutorService { /* private fields */ }

Rayon-backed executor service for CPU-bound synchronous tasks.

Accepted tasks are executed on a dedicated Rayon thread pool. The service preserves the crate’s ExecutorService lifecycle semantics and task-handle APIs while delegating scheduling to Rayon.

Implementations

impl RayonExecutorService

pub fn new() -> Result<Self, RayonExecutorServiceBuildError>

Creates a Rayon executor service with default builder settings.

Returns

Ok(RayonExecutorService) if the default Rayon thread pool can be built.

Errors

Returns RayonExecutorServiceBuildError if the default builder configuration is rejected.

pub fn builder() -> RayonExecutorServiceBuilder

Creates a builder for configuring a Rayon executor service.

Returns

A builder configured with CPU-parallelism defaults.

Trait Implementations

impl Clone for RayonExecutorService

fn clone(&self) -> RayonExecutorService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ExecutorService for RayonExecutorService

fn submit_callable<C, R, E>( &self, task: C, ) -> Result<Self::Handle<R, E>, RejectedExecution>

where C: Callable<R, E> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts a callable and schedules it on the Rayon thread pool.

Parameters

• task - Callable to execute on a Rayon worker.

Returns

A RayonTaskHandle for the accepted task.

Errors

Returns RejectedExecution::Shutdown if shutdown has already been requested before the task is accepted.

fn shutdown(&self)

Stops accepting new tasks.

Already accepted Rayon tasks are allowed to finish normally.

fn shutdown_now(&self) -> ShutdownReport

Stops accepting new tasks and cancels tasks that have not started yet.

Running Rayon tasks cannot be preempted. Cancellation therefore applies only to tasks that are still pending when the cancellation hook wins the race against task start.

Returns

A count-based report describing the pending and running work observed at the time of the shutdown request, plus the number of pending tasks for which cancellation succeeded.

fn is_shutdown(&self) -> bool

Returns whether shutdown has been requested.

fn is_terminated(&self) -> bool

Returns whether shutdown was requested and no accepted tasks remain.

fn await_termination(&self) -> Self::Termination<'_>

Waits until the service has terminated.

Returns

A future that resolves after shutdown has been requested and all accepted Rayon tasks have completed or been cancelled before start.

type Handle<R, E> = RayonTaskHandle<R, E> where R: Send + 'static, E: Send + 'static

Handle returned for an accepted task.

type Termination<'a> = Pin<Box<dyn Future<Output = ()> + Send + 'a>> where Self: 'a

Future returned when waiting for service termination.

fn submit<T, E>( &self, task: T, ) -> Result<Self::Handle<(), E>, RejectedExecution>

where T: Runnable<E> + Send + 'static, E: Send + 'static,

Submits a runnable task to this service.