dispatch2 0.3.0

Bindings and wrappers for Apple's Grand Central Dispatch (GCD)
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

use core::mem::ManuallyDrop;

use crate::{DispatchObject, DispatchRetained};

use crate::{DispatchTime, WaitError};

dispatch_object!(
    /// Dispatch semaphore.
    #[doc(alias = "dispatch_semaphore_t")]
    #[doc(alias = "dispatch_semaphore_s")]
    pub struct DispatchSemaphore;
);

dispatch_object_not_data!(unsafe DispatchSemaphore);

impl DispatchSemaphore {
    /// Attempt to acquire the [`DispatchSemaphore`] and return a [`DispatchSemaphoreGuard`].
    ///
    /// # Errors
    ///
    /// Return [WaitError::TimeOverflow] if the passed ``timeout`` is too big.
    ///
    /// Return [WaitError::Timeout] in case of timeout.
    pub fn try_acquire(&self, timeout: DispatchTime) -> Result<DispatchSemaphoreGuard, WaitError> {
        // Safety: DispatchSemaphore cannot be null.
        let result = Self::wait(self, timeout);

        match result {
            0 => Ok(DispatchSemaphoreGuard(self.retain())),
            _ => Err(WaitError::Timeout),
        }
    }
}

/// Dispatch semaphore guard.
#[derive(Debug)]
pub struct DispatchSemaphoreGuard(DispatchRetained<DispatchSemaphore>);

impl DispatchSemaphoreGuard {
    /// Release the [`DispatchSemaphore`].
    pub fn release(self) -> bool {
        let this = ManuallyDrop::new(self);

        // SAFETY: DispatchSemaphore cannot be null.
        let result = this.0.signal();

        result != 0
    }
}

impl Drop for DispatchSemaphoreGuard {
    fn drop(&mut self) {
        // SAFETY: DispatchSemaphore cannot be null.
        self.0.signal();
    }
}