async-selector 0.4.0

Fast and flexible asynchronous task selector
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use std::{
    ops::{Deref, DerefMut},
    pin::Pin,
};

use crate::{list, selector::Id};

/// Immutable reference to a task stored in a [`Selector`](super::Selector).
pub struct Borrowed<'a, T>(pub(super) list::Borrowed<&'a T>);

impl<'a, T> Borrowed<'a, T> {
    /// Returns the ID of the task.
    pub fn id(&self) -> &Id<T> {
        Id::new(self.0.node())
    }

    /// Returns a pinned reference to the task.
    pub fn get_pin(&self) -> Pin<&T> {
        self.0.get_pin()
    }

    /// Consumes this wrapper, returning a pinned reference to the task.
    pub fn into_pin(self) -> Pin<&'a T> {
        self.0.into_pin()
    }
}

impl<C> Deref for Borrowed<'_, C> {
    type Target = C;

    fn deref(&self) -> &Self::Target {
        self.get_pin().get_ref()
    }
}

/// Mutable reference to a task stored in a [`Selector`](super::Selector).
pub struct BorrowedMut<'a, T>(pub(super) list::Borrowed<&'a mut T>);

impl<'a, T> BorrowedMut<'a, T> {
    /// Returns the ID of the task.
    pub fn id(&self) -> &Id<T> {
        Id::new(self.0.node())
    }

    /// Returns a pinned reference to the task.
    pub fn get_pin(&self) -> Pin<&T> {
        self.0.get_pin()
    }

    /// Consumes this wrapper, returning a pinned reference to the task.
    pub fn into_pin(self) -> Pin<&'a T> {
        self.0.into_pin_mut().into_ref()
    }

    /// Returns a mutable pinned reference to the task.
    pub fn get_pin_mut(&mut self) -> Pin<&mut T> {
        self.0.get_pin_mut()
    }

    /// Consumes this wrapper, returning a mutable pinned reference to the task.
    pub fn into_pin_mut(self) -> Pin<&'a mut T> {
        self.0.into_pin_mut()
    }
}

impl<C> Deref for BorrowedMut<'_, C> {
    type Target = C;

    fn deref(&self) -> &Self::Target {
        self.get_pin().get_ref()
    }
}

impl<C: Unpin> DerefMut for BorrowedMut<'_, C> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.get_pin_mut().get_mut()
    }
}

/// Task removed from a [`Selector`](super::Selector).
pub struct Removed<T>(pub(super) list::Removed<T>);

impl<T> Removed<T> {
    /// Returns the ID of the task.
    pub fn id(&self) -> &Id<T> {
        Id::new(self.0.node())
    }

    /// Returns a pinned reference to the task.
    pub fn get_pin(&self) -> Pin<&T> {
        self.0.get_pin()
    }

    /// Returns a mutable pinned reference to the task.
    pub fn get_pin_mut(&mut self) -> Pin<&mut T> {
        self.0.get_pin_mut()
    }

    /// Consumes this wrapper, returning the task.
    ///
    /// Since this method moves the task in memory,
    /// it is only available when `T` is [`Unpin`].
    pub fn into_inner(self) -> T
    where
        T: Unpin,
    {
        self.0.into_inner()
    }
}

impl<T> Deref for Removed<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.get_pin().get_ref()
    }
}

impl<T: Unpin> DerefMut for Removed<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.get_pin_mut().get_mut()
    }
}