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<T, E>(&self, task: T) -> Result<(), SubmissionError>

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

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

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

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 TaskHandle for the accepted task.

Errors

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

fn submit_tracked_callable<C, R, E>( &self, task: C, ) -> Result<Self::TrackedHandle<R, E>, SubmissionError>

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

Accepts a callable and schedules it with a tracked handle.

fn shutdown(&self)

Stops accepting new tasks.

Already accepted Rayon tasks are allowed to finish normally.

fn stop(&self) -> StopReport

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 stop request, plus the number of pending tasks for which cancellation succeeded.

fn lifecycle(&self) -> ExecutorServiceLifecycle

Returns the current lifecycle state.

fn is_not_running(&self) -> bool

Returns whether shutdown has been requested.

fn is_terminated(&self) -> bool

Returns whether shutdown was requested and no accepted tasks remain.

fn wait_termination(&self)

Blocks until the service has terminated.

type ResultHandle<R, E> = TaskHandle<R, E> where R: Send + 'static, E: Send + 'static

Result handle returned for an accepted callable task.

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

Tracked handle returned for accepted tasks that expose status.

fn submit_tracked<T, E>( &self, task: T, ) -> Result<Self::TrackedHandle<(), E>, SubmissionError>

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

Submits a runnable task and returns a tracked handle.

fn is_running(&self) -> bool

Returns whether the service accepts new tasks.

fn is_shutting_down(&self) -> bool

Returns whether graceful shutdown is in progress.

fn is_stopping(&self) -> bool

Returns whether abrupt stop is in progress.