scheduled_thread_pool/
builder.rs

Help
1//! Staged builder types.
2
3use crate::{OnPoolDropBehavior, ScheduledThreadPool};
4
5/// The builder stage expecting the `num_threads` value.
6pub struct NumThreadsStage(pub(crate) ());
7
8impl NumThreadsStage {
9    /// Specifies the number of threads the pool should use.
10    ///
11    /// # Panics
12    ///
13    /// Panics if `num_threads` is 0.
14    pub fn num_threads<'a>(self, num_threads: usize) -> FinalStage<'a> {
15        assert!(num_threads > 0, "num_threads must be positive");
16        FinalStage {
17            num_threads,
18            thread_name_pattern: None,
19            on_drop_behavior: OnPoolDropBehavior::CompletePendingScheduled,
20        }
21    }
22}
23
24/// The final builder stage, allowing configuration of optional paramters.
25pub struct FinalStage<'a> {
26    pub(crate) num_threads: usize,
27    pub(crate) thread_name_pattern: Option<&'a str>,
28    pub(crate) on_drop_behavior: OnPoolDropBehavior,
29}
30
31impl<'a> FinalStage<'a> {
32    /// Sets the pattern to be used when naming threads created to be part of the
33    /// pool.
34    ///
35    /// The substring `{}` in the name will be replaced with an integer
36    /// identifier of the thread.
37    ///
38    /// Defaults to `None`.
39    pub fn thread_name_pattern(mut self, thread_name_pattern: &'a str) -> Self {
40        self.thread_name_pattern = Some(thread_name_pattern);
41        self
42    }
43
44    /// Sets the behavior for what to do with pending scheduled executions when
45    /// the pool is dropped.
46    ///
47    /// Defaults to [OnPoolDropBehavior::CompletePendingScheduled].
48    pub fn on_drop_behavior(mut self, on_drop_behavior: OnPoolDropBehavior) -> Self {
49        self.on_drop_behavior = on_drop_behavior;
50        self
51    }
52
53    /// Consumes the builder, returning the constructed thread pool.
54    pub fn build(self) -> ScheduledThreadPool {
55        ScheduledThreadPool::new_inner(self)
56    }
57}
scheduled_thread_pool/builder.rs

scheduled_thread_pool/
builder.rs
