way 0.0.0-beta1

Fast Async Channel With no-std Support and Alternative Sync API
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use branches::unlikely;
use swait::*;

use crate::{
    error::{CloseError, ReceiveError, SendError},
    internal::Internal,
    ReceiveErrorTimeout, Receiver, Sender,
};

#[repr(C)]
pub struct SyncSender<T, const CAPACITY: usize = 0> {
    internal: Internal<T, CAPACITY>,
}

macro_rules! shared_impl {
    () => {
        pub fn len(&self) -> usize {
            self.internal.lock_sync().queue.len()
        }

        pub fn is_empty(&self) -> bool {
            self.len() == 0
        }

        pub fn is_full(&self) -> bool {
            if CAPACITY == 0 {
                return true;
            }
            CAPACITY == self.internal.lock_sync().queue.len()
        }

        pub fn capacity(&self) -> usize {
            CAPACITY
        }

        pub fn receiver_count(&self) -> usize {
            self.internal.lock_sync().recv_count
        }

        pub fn sender_count(&self) -> usize {
            self.internal.lock_sync().send_count
        }

        pub fn close(&self) -> Result<(), CloseError> {
            let mut internal = self.internal.lock_sync();
            if unlikely(internal.recv_count == 0 && internal.send_count == 0) {
                return Err(CloseError());
            }
            internal.recv_count = 0;
            internal.send_count = 0;
            internal.terminate_signals();
            internal.queue.clear();
            Ok(())
        }

        pub fn is_closed(&self) -> bool {
            let internal = self.internal.lock_sync();
            internal.send_count == 0 && internal.recv_count == 0
        }
    };
}

impl<T, const CAPACITY: usize> SyncSender<T, CAPACITY> {
    shared_impl!();
    pub fn as_async(&self) -> &Sender<T, CAPACITY> {
        // SAFETY: SyncSender and Sender have the same layout
        unsafe { core::mem::transmute(self) }
    }
    pub fn to_async(self) -> Sender<T, CAPACITY> {
        // SAFETY: SyncSender and Sender have the same layout
        unsafe { core::mem::transmute(self) }
    }
    pub fn send(&self, value: T) -> Result<(), SendError<T>> {
        self.as_async().send(value).swait()
    }
    pub fn try_send(&self, data: T) -> Result<(), SendError<T>> {
        self.as_async().try_send(data).swait()
    }

    pub fn try_send_realtime(&self, data: T) -> Result<(), SendError<T>> {
        self.as_async().try_send_realtime(data)
    }
    pub fn is_disconnected(&self) -> bool {
        self.as_async().is_disconnected().swait()
    }
}

impl<T, const CAPACITY: usize> Clone for SyncSender<T, CAPACITY> {
    fn clone(&self) -> Self {
        self.internal.lock_sync().inc_ref_count(true);
        SyncSender {
            internal: self.internal.clone(),
        }
    }
}

impl<T, const CAPACITY: usize> Drop for SyncSender<T, CAPACITY> {
    fn drop(&mut self) {
        let mut guard = self.internal.lock_sync();
        if guard.dec_ref_count(true) {
            // SAFETY: this was the last refrence to the internal channel, it's safe to
            // deallocate it now
            drop(guard);
            unsafe {
                _ = Box::from_raw(self.internal.inner);
            }
        }
    }
}

#[repr(C)]
pub struct SyncReceiver<T, const CAPACITY: usize = 0> {
    internal: Internal<T, CAPACITY>,
}

impl<T, const CAPACITY: usize> SyncReceiver<T, CAPACITY> {
    shared_impl!();
    pub fn as_async(&self) -> &Receiver<T, CAPACITY> {
        // SAFETY: SyncReceiver and Receiver have the same layout
        unsafe { &*(self as *const SyncReceiver<T, CAPACITY> as *const Receiver<T, CAPACITY>) }
    }
    pub fn to_async(self) -> Sender<T, CAPACITY> {
        // SAFETY: SyncReceiver and Receiver have the same layout
        unsafe { core::mem::transmute(self) }
    }
    pub fn recv(&self) -> Result<T, ReceiveError> {
        self.as_async().recv().swait()
    }

    pub fn try_recv(&self) -> Result<T, ReceiveErrorTimeout> {
        self.as_async().try_recv().swait()
    }

    pub fn try_recv_realtime(&self) -> Result<T, ReceiveErrorTimeout> {
        self.as_async().try_recv_realtime()
    }

    pub fn is_disconnected(&self) -> bool {
        self.as_async().is_disconnected().swait()
    }
}

impl<T, const CAPACITY: usize> Clone for SyncReceiver<T, CAPACITY> {
    fn clone(&self) -> Self {
        self.internal.lock_sync().inc_ref_count(false);
        SyncReceiver {
            internal: self.internal.clone(),
        }
    }
}

impl<T, const CAPACITY: usize> Drop for SyncReceiver<T, CAPACITY> {
    fn drop(&mut self) {
        let mut guard = self.internal.lock_sync();
        if guard.dec_ref_count(false) {
            // SAFETY: this was the last refrence to the internal channel, it's safe to
            // deallocate it now
            drop(guard);
            unsafe {
                _ = Box::from_raw(self.internal.inner);
            }
        }
    }
}

pub fn bounded_sync<T, const CAPACITY: usize>(
) -> (SyncSender<T, CAPACITY>, SyncReceiver<T, CAPACITY>) {
    let internal = Internal::<T, CAPACITY>::new();
    (
        SyncSender {
            internal: internal.clone(),
        },
        SyncReceiver { internal },
    )
}

pub fn zero_sync<T>() -> (SyncSender<T, 0>, SyncReceiver<T, 0>) {
    bounded_sync::<T, 0>()
}