embedded-executor 0.6.1

Embedded systems-friendly `Futures` executor
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
63
64
65
66
67
68
69
70
71

use core::task::{
    RawWaker,
    Waker,
};

#[cfg(any(feature = "alloc", feature = "std"))]
use alloc::sync::Arc;

/// Wake trait
///
/// Should be combined with [`crate::Sleep`] in order to be used with the
/// [`crate::AllocExecutor`].
pub trait Wake {
    /// Wake up the sleepers.
    fn wake(&self);
}

#[cfg(any(feature = "alloc", feature = "std"))]
pub(crate) trait WakeExt: Wake + Sized {
    fn into_raw_waker(self: Arc<Self>) -> RawWaker {
        RawWaker::new(Arc::into_raw(self) as _, arc::arc_waker_vtable::<Self>())
    }

    fn into_waker(self: Arc<Self>) -> Waker {
        unsafe { Waker::from_raw(self.into_raw_waker()) }
    }
}

#[cfg(any(feature = "alloc", feature = "std"))]
impl<T> WakeExt for T where T: Sized + Wake {}

#[cfg(any(feature = "alloc", feature = "std"))]
mod arc {
    use core::{
        mem,
        task::RawWakerVTable,
    };

    use super::*;

    pub unsafe fn clone_arc_waker_raw<T: Wake>(ptr: *const ()) -> RawWaker {
        let arc = Arc::<T>::from_raw(ptr as _);
        let cloned = arc.clone();
        mem::forget(arc);
        cloned.into_raw_waker()
    }

    pub unsafe fn drop_arc_waker_raw<T>(ptr: *const ()) {
        drop(Arc::<T>::from_raw(ptr as _));
    }

    pub unsafe fn wake_arc_waker_raw<T: Wake>(ptr: *const ()) {
        let arc = Arc::<T>::from_raw(ptr as _);
        arc.wake();
    }

    pub unsafe fn wake_by_ref_arc_waker_raw<T: Wake>(ptr: *const ()) {
        let arc = Arc::<T>::from_raw(ptr as _);
        arc.wake();
        mem::forget(arc);
    }

    pub fn arc_waker_vtable<T: Wake>() -> &'static RawWakerVTable {
        &RawWakerVTable::new(
            clone_arc_waker_raw::<T>,
            wake_arc_waker_raw::<T>,
            wake_by_ref_arc_waker_raw::<T>,
            drop_arc_waker_raw::<T>,
        )
    }
}