Struct Pool 

pub struct Pool { /* private fields */ }

A worker pool that executes tasks on the same processor that spawned them.

This ensures optimal cache locality and minimizes cross-processor data movement.

Lifetime

When the pool is dropped:

1. All worker threads are signaled to shut down.
2. The drop blocks until all currently-executing tasks complete.
3. Any queued tasks that have not started are abandoned.

To ensure all tasks complete, await their JoinHandles before dropping the pool.

Example

use vicinal::Pool;

let pool = Pool::new();
let scheduler = pool.scheduler();

let handle = scheduler.spawn(|| 42);
assert_eq!(handle.await, 42);

Implementations

impl Pool

pub fn new() -> Self

Creates a new pool with default settings.

Use Pool::builder() for custom configuration.

pub fn builder() -> PoolBuilder

Creates a builder for configuring the pool.

pub fn scheduler(&self) -> Scheduler

Returns a scheduler that can be used to spawn tasks on this pool.

The scheduler can be cloned and shared across threads.

Trait Implementations

impl Debug for Pool

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

Formats the value using the given formatter.

impl Default for Pool

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Pool

fn drop(&mut self)

Executes the destructor for this type.