Struct ZeroPool 

pub struct ZeroPool { /* private fields */ }

Implementations

impl ZeroPool

pub fn new() -> Self

Creates a new thread pool with worker count equal to available parallelism

Worker count is determined by std::thread::available_parallelism(), falling back to 1 if unavailable. This is usually the optimal choice for CPU-bound workloads.

Examples

use zero_pool::ZeroPool;
let pool = ZeroPool::new();

pub fn with_workers(worker_count: usize) -> Self

Creates a new thread pool with the specified number of workers

Use this when you need precise control over the worker count, for example when coordinating with other thread pools or when you know the optimal count for your specific workload.

Panics

Panics if worker_count is 0.

use zero_pool::ZeroPool;
let pool = ZeroPool::with_workers(4);

pub fn submit_raw_task( &self, task_fn: TaskFnPointer, params: TaskParamPointer, ) -> TaskFuture

Submit a single task using raw function and parameter pointers

This is the lowest-level submission method with minimal overhead. Most users should prefer the type-safe submit_task method.

Safety

The parameter pointer must remain valid until the returned future completes. The caller must ensure the pointer points to the correct parameter type expected by the task function.

Examples

use zero_pool::{ZeroPool, TaskFnPointer, TaskParamPointer, zp_define_task_fn, zp_write};

struct MyTaskParams { value: u64, result: *mut u64 }

zp_define_task_fn!(my_task, MyTaskParams, |params| {
    zp_write!(params.result, params.value * 2);
});

let pool = ZeroPool::new();
let mut result = 0u64;
let task_params = MyTaskParams { value: 42, result: &mut result };
let future = pool.submit_raw_task(
    my_task as TaskFnPointer,
    &task_params as *const _ as TaskParamPointer
);
future.wait();
assert_eq!(result, 84);

pub fn submit_raw_task_batch(&self, tasks: &[TaskItem]) -> TaskFuture

Submit a batch of tasks using raw work items

This method provides optimal performance for pre-converted task batches. Use uniform_tasks_to_pointers to convert typed tasks efficiently, or build work items manually for mixed task types.

Examples

use zero_pool::{ZeroPool, uniform_tasks_to_pointers, zp_define_task_fn, zp_write};

struct MyTaskParams { value: u64, result: *mut u64 }

zp_define_task_fn!(my_task, MyTaskParams, |params| {
    zp_write!(params.result, params.value * 2);
});

let pool = ZeroPool::new();
let mut results = vec![0u64; 2];
let task_params = vec![
    MyTaskParams { value: 1, result: &mut results[0] },
    MyTaskParams { value: 2, result: &mut results[1] }
];
let tasks = uniform_tasks_to_pointers(my_task, &task_params);
let future = pool.submit_raw_task_batch(&tasks);
future.wait();
assert_eq!(results[0], 2);
assert_eq!(results[1], 4);

pub fn submit_task<T>(&self, task_fn: TaskFnPointer, params: &T) -> TaskFuture

Submit a single typed task with automatic pointer conversion

This method provides type safety while maintaining performance. The parameter struct must remain valid until the future completes. This is the recommended method for submitting individual tasks.

Examples

use zero_pool::{ZeroPool, zp_define_task_fn, zp_write};

struct MyTaskParams { value: u64, result: *mut u64 }

zp_define_task_fn!(my_task_fn, MyTaskParams, |params| {
    zp_write!(params.result, params.value * 2);
});

let pool = ZeroPool::new();
let mut result = 0u64;
let task_params = MyTaskParams { value: 42, result: &mut result };
let future = pool.submit_task(my_task_fn, &task_params);
future.wait();
assert_eq!(result, 84);

pub fn submit_batch_uniform<T>( &self, task_fn: TaskFnPointer, params_vec: &[T], ) -> TaskFuture

Submit a batch of uniform tasks with automatic pointer conversion

All tasks in the batch must be the same type and use the same task function. This method handles the pointer conversion automatically and is the most convenient way to submit large batches of similar work.

Examples

use zero_pool::{ZeroPool, zp_define_task_fn, zp_write};

struct MyTaskParams { value: u64, result: *mut u64 }

zp_define_task_fn!(my_task_fn, MyTaskParams, |params| {
    zp_write!(params.result, params.value * 2);
});

let pool = ZeroPool::new();
let mut results = vec![0u64; 1000];
let task_params: Vec<_> = (0..1000)
    .map(|i| MyTaskParams { value: i as u64, result: &mut results[i] })
    .collect();
let future = pool.submit_batch_uniform(my_task_fn, &task_params);
future.wait();
assert_eq!(results[0], 0);
assert_eq!(results[1], 2);
assert_eq!(results[999], 1998);

Trait Implementations

impl Drop for ZeroPool

fn drop(&mut self)

Executes the destructor for this type.