orengine 0.7.0-alpha.1

Optimized ring engine for Rust. It is a lighter and faster asynchronous library than tokio-rs, async-std, may, and even smol.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

/// In systems with 64-bit pointers, the high bit is reserved for the task-locality flag
/// caused by the fact that `*mut dyn` can be safely cast to `i128`.
///
/// `IS_LOCAL_SHIFT` is the shift amount for the task-locality flag.
#[cfg(target_pointer_width = "64")]
pub(crate) const IS_LOCAL_SHIFT: i128 = 127;
/// In systems with 64-bit pointers, the high bit is reserved for the task-locality flag
/// caused by the fact that `*mut dyn` can be safely cast to `i128`.
///
/// `TASK_MASK` is the mask for the task associated with the current tagged ptr.
#[cfg(target_pointer_width = "64")]
pub(crate) const TASK_MASK: i128 = !(1 << IS_LOCAL_SHIFT);

/// In systems with 64-bit pointers, the high bit is reserved for the task-locality flag
/// caused by the fact that `*mut dyn` can be safely cast to `i128`.
///
/// `IS_LOCAL_MASK` is the mask for the task-locality flag associated with the current tagged ptr.
#[cfg(target_pointer_width = "64")]
pub(crate) const IS_LOCAL_MASK: i128 = 1 << IS_LOCAL_SHIFT;

/// `Locality` is a struct that represents whether a task is [`local`](Locality::local)
/// or [`shared`](Locality::shared).
///
/// # The difference between shared and local tasks
///
/// Read it in [`crate::Executor`].
#[derive(Clone, Copy, Debug)]
pub struct Locality {
    #[cfg(not(target_pointer_width = "64"))]
    pub(crate) value: bool,
    #[cfg(target_pointer_width = "64")]
    pub(crate) value: i128,
}

impl Locality {
    /// Creates a new `Locality` with a `local` value.
    ///
    /// # The difference between shared and local tasks
    ///
    /// Read it in [`crate::Executor`].
    #[inline(always)]
    pub fn local() -> Self {
        #[cfg(not(target_pointer_width = "64"))]
        {
            Self { value: true }
        }

        #[cfg(target_pointer_width = "64")]
        Self {
            value: IS_LOCAL_MASK,
        }
    }

    /// Creates a new `Locality` with a `shared` value.
    ///
    /// # The difference between shared and local tasks
    ///
    /// Read it in [`crate::Executor`].
    #[inline(always)]
    pub fn shared() -> Self {
        #[cfg(not(target_pointer_width = "64"))]
        {
            Self { value: false }
        }

        #[cfg(target_pointer_width = "64")]
        Self { value: 0 }
    }

    /// Returns whether the `Locality` is `local`.
    ///
    /// # The difference between shared and local tasks
    ///
    /// Read it in [`crate::Executor`].
    #[inline(always)]
    pub fn is_local(&self) -> bool {
        #[cfg(not(target_pointer_width = "64"))]
        {
            self.value
        }

        #[cfg(target_pointer_width = "64")]
        {
            self.value != 0
        }
    }
}