Struct easy_parallel::Parallel

pub struct Parallel<'a, T> { /* private fields */ }

A builder that runs closures in parallel.

Implementations

impl<'a, T> Parallel<'a, T>

pub fn new() -> Parallel<'a, T>

Creates a builder for running closures in parallel.

Examples

use easy_parallel::Parallel;

let p = Parallel::<()>::new();

pub fn add<F>(self, f: F) -> Parallel<'a, T> where
    F: FnOnce() -> T + Send + 'a,
    T: Send + 'a, 

Adds a closure to the list.

Examples

use easy_parallel::Parallel;

Parallel::new()
    .add(|| println!("hello from a thread"))
    .run();

pub fn each<A, I, F>(self, iter: I, f: F) -> Parallel<'a, T> where
    I: IntoIterator<Item = A>,
    F: FnOnce(A) -> T + Clone + Send + 'a,
    A: Send + 'a,
    T: Send + 'a, 

Adds a cloned closure for each item in an iterator.

Each clone of the closure takes an item as an argument.

Examples

use easy_parallel::Parallel;

Parallel::new()
    .each(0..5, |i| println!("hello from thread #{}", i))
    .run();

pub fn run(self) -> Vec<T> where
    T: Send + 'a, 

Runs each closure on a separate thread and collects their results.

Results are collected in the order in which closures were added. One of the closures always runs on the main thread because there is no point in spawning an extra thread for it.

If a closure panics, panicking will resume in the main thread after all threads are joined.

Examples

use easy_parallel::Parallel;
use std::thread;
use std::time::Duration;

let res = Parallel::new()
    .each(1..=3, |i| 10 * i)
    .add(|| 100)
    .run();

assert_eq!(res, [10, 20, 30, 100]);

pub fn finish<F, R>(self, f: F) -> (Vec<T>, R) where
    F: FnOnce() -> R,
    T: Send + 'a, 

Finishes with a closure to run on the main thread, starts threads, and collects results.

Results are collected in the order in which closures were added.

If a closure panics, panicking will resume in the main thread after all threads are joined.

Examples

use easy_parallel::Parallel;
use std::thread;
use std::time::Duration;

let (res, ()) = Parallel::new()
    .each(1..=3, |i| 10 * i)
    .finish(|| println!("Waiting for results"));

assert_eq!(res, [10, 20, 30]);

Trait Implementations

impl<T> Debug for Parallel<'_, T>

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

Formats the value using the given formatter.

impl<T> Default for Parallel<'_, T>

fn default() -> Self

Returns the “default value” for a type.