threadfin 0.1.2

A thread pool for running multiple tasks on a configurable group of threads.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use crate::{Builder, CommonAlreadyInitializedError, ThreadPool};
use once_cell::sync::OnceCell;

static COMMON: OnceCell<ThreadPool> = OnceCell::new();

/// Get a shared reference to a common thread pool for the entire process.
///
/// # Examples
///
/// ```
/// let result = threadfin::common().execute(|| 2 + 2).join();
///
/// assert_eq!(result, 4);
/// ```
pub fn common() -> &'static ThreadPool {
    COMMON.get_or_init(|| common_builder().build())
}

/// Configure the common thread pool.
///
/// This should be done near the start of your program before any other code
/// uses the common pool, as this function will return an error if the common
/// pool has already been initialized.
///
/// Only programs should use this function! Libraries should not use this
/// function and instead allow the running program to configure the common pool.
/// If you need a customized pool in a library then you should use a separate
/// pool instance.
///
/// # Examples
///
/// ```
/// threadfin::configure_common(|builder| builder
///     .size(3)
///     .queue_limit(1024))
///     .unwrap();
///
/// assert_eq!(threadfin::common().threads(), 3);
/// ```
pub fn configure_common<F>(f: F) -> Result<(), CommonAlreadyInitializedError>
where
    F: FnOnce(Builder) -> Builder,
{
    let mut was_initialized = true;

    COMMON.get_or_init(|| {
        was_initialized = false;
        f(common_builder()).build()
    });

    if was_initialized {
        Err(CommonAlreadyInitializedError::new())
    } else {
        Ok(())
    }
}

fn common_builder() -> Builder {
    Builder::default().name("common-pool")
}