songbird 0.6.0

An async Rust library for the Discord voice API.
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
61
62
63
64

use super::*;

/// Configuration for how a [`Scheduler`] handles tasks.
///
/// [`Scheduler`]: super::Scheduler
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct Config {
    /// How Live mixer tasks will be mapped to individual threads.
    ///
    /// Defaults to `Mode::MaxPerThread(16)`.
    pub strategy: Mode,
    /// Move costly mixers to another thread if their parent worker is at
    /// risk of missing its deadlines.
    ///
    /// Defaults to `true`.
    pub move_expensive_tasks: bool,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            strategy: Mode::default(),
            move_expensive_tasks: true,
        }
    }
}

/// Strategies for mapping live mixer tasks to individual threads.
///
/// Defaults to `MaxPerThread(16)`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum Mode {
    /// Allows at most `n` tasks to run per thread.
    MaxPerThread(NonZeroUsize),
}

impl Mode {
    /// Returns the number of `Mixer`s that a scheduler should preallocate
    /// resources for.
    pub(crate) fn prealloc_size(&self) -> usize {
        match self {
            Self::MaxPerThread(n) => n.get(),
        }
    }

    /// Returns the maximum number of concurrent mixers that a scheduler is
    /// allowed to place on a single thread.
    ///
    /// Future scheduling modes may choose to limit *only* on execution cost.
    #[allow(clippy::unnecessary_wraps)]
    pub(crate) fn task_limit(&self) -> Option<usize> {
        match self {
            Self::MaxPerThread(n) => Some(n.get()),
        }
    }
}

impl Default for Mode {
    fn default() -> Self {
        Self::MaxPerThread(DEFAULT_MIXERS_PER_THREAD)
    }
}