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 nonmax::NonMaxU32;
use std::time::Duration;

/// A type similar to [`std::time::Duration`] except using an `f32`.
///
/// This limits precision, only allowing by-second precision up to ~194 days,
/// but in turn shinks type size from `16` bytes to `4` bytes.
///
/// # Implementation Note
///
/// We actually store this as `NonMaxU32`, in order to get a niche to make `Option<FloatDuration>` the same size.
#[derive(Clone, Copy)]
pub struct FloatDuration(NonMaxU32);

impl FloatDuration {
    /// Creates a [`FloatDuration`] from a raw `f32` value.
    ///
    /// # Panics
    /// This may panic if `value` is a NaN value.
    #[must_use]
    pub fn from_secs_f32(value: f32) -> Self {
        Self(NonMaxU32::new(value.to_bits()).expect("value should not be NaN"))
    }

    /// Converts a [`FloatDuration`] to an `f32`.
    ///
    /// This is cheaper than converting to a [`Duration`] and using [`Duration::as_secs_f32`] as it is more direct.
    #[must_use]
    pub fn as_secs_f32(self) -> f32 {
        f32::from_bits(self.0.get())
    }
}

impl std::fmt::Debug for FloatDuration {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("FloatDuration")
            .field(&Duration::from(*self))
            .finish()
    }
}

impl PartialEq for FloatDuration {
    fn eq(&self, other: &Self) -> bool {
        self.as_secs_f32() == other.as_secs_f32()
    }
}

impl PartialOrd for FloatDuration {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        self.as_secs_f32().partial_cmp(&other.as_secs_f32())
    }
}

impl From<Duration> for FloatDuration {
    fn from(value: Duration) -> Self {
        Self::from_secs_f32(value.as_secs_f32())
    }
}

impl From<FloatDuration> for Duration {
    fn from(value: FloatDuration) -> Self {
        Duration::from_secs_f32(value.as_secs_f32())
    }
}