baseview 0.4.1

Low-level windowing system geared towards making audio plugin UIs.
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
61
62

use crate::platform;
use std::marker::PhantomData;

/// A weak handle to a [timer].
///
/// This handle can be used to identify which timer has been triggered during a [`on_timer`] event
/// using its [`PartialEq`] implementation.
///
/// It can also be cheaply [cloned](Clone) for convenience. All cloned handles represent the same
/// timer instance, and will always compare equal to one another.
///
/// Note this is a weak handle and is not tied at all to the actual timer's lifetime. A timer may
/// be invalidated and/or destroyed while this handle is still alive.
///
/// Conversely, dropping this handle has no effect on the lifetime of the timer, and it may still
/// fire after all handles have been dropped.
///
/// All timers are automatically destroyed and stopped when the associated window is destroyed.
///
/// [timer]: crate::WindowContext::create_timer
/// [`on_timer`]: crate::WindowHandler::on_timer
#[derive(PartialEq, Eq, Clone)]
#[repr(transparent)]
pub struct TimerHandle {
    inner: platform::TimerHandle,
    _nonsend: PhantomData<*mut ()>, // Ensures this is !Send & !Sync on all platforms
}

impl TimerHandle {
    pub(crate) fn from_ref(handle: &platform::TimerHandle) -> &TimerHandle {
        // SAFETY: This is repr(transparent)
        unsafe { core::mem::transmute::<&platform::TimerHandle, &TimerHandle>(handle) }
    }
}

impl From<platform::TimerHandle> for TimerHandle {
    #[inline]
    fn from(value: platform::TimerHandle) -> Self {
        Self { inner: value, _nonsend: PhantomData }
    }
}

impl<'a> From<&'a platform::TimerHandle> for &'a TimerHandle {
    #[inline]
    fn from(value: &'a platform::TimerHandle) -> Self {
        TimerHandle::from_ref(value)
    }
}

impl PartialEq<&TimerHandle> for TimerHandle {
    #[inline]
    fn eq(&self, other: &&TimerHandle) -> bool {
        self == *other
    }
}

impl PartialEq<TimerHandle> for &TimerHandle {
    #[inline]
    fn eq(&self, other: &TimerHandle) -> bool {
        *self == other
    }
}