kvbm-config 1.2.1

KVBM Configuration Library for Tokio, Rayon, and Messenger runtimes
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

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Rayon thread pool configuration.

use serde::{Deserialize, Serialize};
use validator::Validate;

/// Rayon thread pool configuration.
#[derive(Debug, Clone, Default, Serialize, Deserialize, Validate)]
pub struct RayonConfig {
    /// Number of threads in the Rayon thread pool.
    /// If None, uses the number of logical CPUs.
    #[validate(range(min = 1))]
    pub num_threads: Option<usize>,
}

#[cfg(feature = "rayon")]
impl RayonConfig {
    /// Build a Rayon thread pool from this configuration.
    pub fn build_pool(&self) -> Result<::rayon::ThreadPool, ::rayon::ThreadPoolBuildError> {
        let mut builder = ::rayon::ThreadPoolBuilder::new();

        if let Some(threads) = self.num_threads {
            builder = builder.num_threads(threads);
        }

        builder.build()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_config() {
        let config = RayonConfig::default();
        assert!(config.num_threads.is_none());
    }

    #[cfg(feature = "rayon")]
    #[test]
    fn test_build_pool() {
        let config = RayonConfig {
            num_threads: Some(2),
        };
        let pool = config.build_pool().expect("Failed to build pool");
        assert_eq!(pool.current_num_threads(), 2);
    }
}