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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
use core::{
    fmt::{self, Formatter, Debug},
    ops::DerefMut,
    cell::RefCell,
    marker::PhantomData,
};
use alloc::{
    boxed::Box,
    sync::Arc,
    rc::Rc,
};
#[cfg(feature = "std")]
use std::{
    sync::{Mutex, RwLock},
};
use super::Entry;

/// Trait for types which wish to be notified when the specified configuration table entry changes.
///
/// Several reference types and standard library types implement `Receiver`:
/// - A mutable borrow of any type can be used as a receiver
pub trait Receiver<E: Entry> {
    /// Receive a notification about the value of the entry changing to the specified new value.
    ///
    /// This method shouldn't be called manually — please use [`EntryStorage`] instead, which will automatically call this method. It's a logic error to invoke this without actually setting the value to something new in the storage.
    ///
    /// [`EntryStorage`]: struct.EntryStorage.html " "
    fn receive(&mut self, new_value: &E::Data);
}

/// A [receiver] which calls a closure when notified.
///
/// [receiver]: trait.Receiver.html " "
#[allow(clippy::module_name_repetitions)]
pub struct FnReceiver<E: Entry, F: FnMut(&E::Data) = Box<dyn FnMut(&<E as Entry>::Data)>> {
    _phantom: PhantomData<E>,
    /// The closure which is called when the receiver is notified.
    pub closure: F,
}
impl<E: Entry, F: FnMut(&E::Data)> FnReceiver<E, F> {
    /// Creates a new receiver from the specified closure.
    // FIXME make it a const fn when non-Sized bounds in const fn arguments get stabilized
    #[inline(always)]
    pub fn new(closure: F) -> Self {
        Self {closure, _phantom: PhantomData}
    }
}
impl<E: Entry, F: FnMut(&E::Data)> Receiver<E> for FnReceiver<E, F> {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (self.closure)(new_value)
    }
}
impl<E: Entry, F: Fn(&E::Data)> Receiver<E> for &FnReceiver<E, F> {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (self.closure)(new_value)
    }
}
impl<E: Entry, F: FnMut(&E::Data) + Clone> Clone for FnReceiver<E, F> {
    #[inline(always)]
    fn clone(&self) -> Self {
        Self {closure: self.closure.clone(), _phantom: PhantomData}
    }
}
impl<E: Entry, F: FnMut(&E::Data) + Copy> Copy for FnReceiver<E, F>
{}

impl<E: Entry, F: FnMut(&E::Data) + Default> Default for FnReceiver<E, F> {
    #[inline(always)]
    fn default() -> Self {
        Self {closure: F::default(), _phantom: PhantomData}
    }
}

impl<E: Entry, F: FnMut(&E::Data) + Debug> Debug for FnReceiver<E, F> {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("FnReceiver")
            .field("closure", &self.closure)
            .finish()
    }
}

/// A [receiver] which creates an iterator from a reference to the contained value and notifies all items which the iterator produces.
///
/// [receiver]: trait.Receiver.html " "
#[allow(clippy::module_name_repetitions)]
pub struct IterReceiver<E: Entry, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    /// The iterable which produces iterators over the receivers.
    pub iter: I,
    _phantom: PhantomData<E>,
}
impl<E: Entry, I> Receiver<E> for IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    #[inline]
    fn receive(&mut self, new_value: &E::Data) {
        for mut receiver in &mut self.iter {
            receiver.receive(new_value);
        }
    }
}
impl<E: Entry, I> Receiver<E> for &IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> &'a I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E>,
    for<'a> <&'a I as IntoIterator>::Item: Receiver<E> {
    #[inline]
    fn receive(&mut self, new_value: &E::Data) {
        for mut receiver in &self.iter {
            receiver.receive(new_value);
        }
    }
}
impl<E: Entry, I> IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    /// Creates a new receiver which notifies the specified iterable of receivers.
    // FIXME make it a const fn when non-Sized bounds in const fn arguments get stabilized
    #[inline(always)]
    pub fn new(iter: I) -> Self {
        Self {iter, _phantom: PhantomData}
    }
}
impl<E: Entry, I: Clone> Clone for IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    #[inline(always)]
    fn clone(&self) -> Self {
        Self {iter: self.iter.clone(), _phantom: PhantomData}
    }
}
impl<E: Entry, I: Copy> Copy for IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {}

impl<E: Entry, I: Default> Default for IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    #[inline(always)]
    fn default() -> Self {
        Self {iter: I::default(), _phantom: PhantomData}
    }
}

impl<E: Entry, I: Debug> Debug for IterReceiver<E, I>
where
    for<'a> &'a mut I: IntoIterator,
    for<'a> <&'a mut I as IntoIterator>::Item: Receiver<E> {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("IterReceiver")
            .field("iter", &self.iter)
            .finish()
    }
}

/// A [receiver] which does nothing when notified.
///
/// [receiver]: trait.Receiver.html " "
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct EmptyReceiver;
impl<E: Entry> Receiver<E> for EmptyReceiver {
    #[inline(always)]
    fn receive(&mut self, _: &E::Data) {}
}
impl<E: Entry> Receiver<E> for &EmptyReceiver {
    #[inline(always)]
    fn receive(&mut self, _: &E::Data) {}
}

//────────────────────────────────────────────────────—┐
// Receiver implementations for builtins and std types |
//─────────────────────────────────────────────────────┘

impl<E, R> Receiver<E> for &mut R
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (*self).receive(new_value);
    }
}
impl<E, R> Receiver<E> for Option<R>
where
    E: Entry,
    R: Receiver<E> {
    #[inline]
    fn receive(&mut self, new_value: &E::Data) {
        if let Some(receiver) = self.as_mut() {
            receiver.receive(new_value);
        }
    }
}
impl<E, R> Receiver<E> for &Option<R>
where
    E: Entry,
    for<'a> &'a R: Receiver<E> {
    #[inline]
    fn receive(&mut self, new_value: &E::Data) {
        if let Some(mut receiver) = self.as_ref() {
            receiver.receive(new_value);
        }
    }
}
impl<E, R> Receiver<E> for Box<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.deref_mut().receive(new_value);
    }
}
impl<E, R> Receiver<E> for &Box<R>
where
    E: Entry,
    R: ?Sized,
    for<'a> &'a R: Receiver<E> {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (&***self).receive(new_value);
    }
}
impl<E, R> Receiver<E> for Rc<R>
where
    E: Entry,
    R: ?Sized,
    for<'a> &'a R: Receiver<E> {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (&**self).receive(new_value);
    }
}
impl<E, R> Receiver<E> for Arc<R>
where
    E: Entry,
    R: ?Sized,
    for<'a> &'a R: Receiver<E> {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (&**self).receive(new_value);
    }
}

impl<E, R> Receiver<E> for RefCell<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.get_mut().receive(new_value);
    }
}
impl<E, R> Receiver<E> for &RefCell<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        (*self.borrow_mut()).receive(new_value);
    }
}

#[cfg(feature = "std")]
static POISONING_MSG: &str = "attempt to use a poisoned lock as a receiver";
#[cfg(feature = "std")]
impl<E, R> Receiver<E> for Mutex<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.get_mut().expect(POISONING_MSG).receive(new_value);
    }
}
#[cfg(feature = "std")]
impl<E, R> Receiver<E> for &Mutex<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.lock().expect(POISONING_MSG).receive(new_value);
    }
}
#[cfg(feature = "std")]
impl<E, R> Receiver<E> for RwLock<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.get_mut().expect(POISONING_MSG).receive(new_value);
    }
}
#[cfg(feature = "std")]
impl<E, R> Receiver<E> for &RwLock<R>
where
    E: Entry,
    R: Receiver<E> + ?Sized {
    #[inline(always)]
    fn receive(&mut self, new_value: &E::Data) {
        self.write().expect(POISONING_MSG).receive(new_value);
    }
}