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
use std::collections::VecDeque;
use std::fmt;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, RwLock, Weak};
use crate::listen::{Listen, Listener};
/// A [`Listener`] which discards all messages and is suitable for filling
/// listener parameters when no listener is needed.
#[allow(clippy::exhaustive_structs)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct NullListener;
impl<M> Listener<M> for NullListener {
fn receive(&self, _message: M) {}
fn alive(&self) -> bool {
false
}
}
/// A [`Listener`] which delivers messages by calling a function on a [`Weak`] reference's
/// referent, and stops when the weak reference breaks.
#[derive(Clone, Debug)]
pub struct FnListener<F, T> {
function: F,
weak_target: Weak<T>,
}
impl<F, T> FnListener<F, T> {
#[allow(missing_docs)]
pub fn new(target: &Arc<T>, function: F) -> Self {
Self {
function,
weak_target: Arc::downgrade(target),
}
}
}
impl<M, F, T> Listener<M> for FnListener<F, T>
where
F: Fn(&T, M),
{
fn receive(&self, message: M) {
if let Some(strong_target) = self.weak_target.upgrade() {
(self.function)(&*strong_target, message);
}
}
fn alive(&self) -> bool {
self.weak_target.strong_count() > 0
}
}
/// A [`Listener`] which stores all the messages it receives.
///
/// This is only intended for testing.
#[derive(Debug)]
pub struct Sink<M> {
messages: Arc<RwLock<VecDeque<M>>>,
}
/// [`Sink::listener()`] implementation.
#[derive(Debug)]
pub struct SinkListener<M> {
weak_messages: Weak<RwLock<VecDeque<M>>>,
}
impl<M> Sink<M> {
/// Constructs a new empty [`Sink`].
pub fn new() -> Self {
Self {
messages: Arc::new(RwLock::new(VecDeque::new())),
}
}
/// Returns a [`Listener`] which records the messages it receives in this Sink.
pub fn listener(&self) -> SinkListener<M> {
SinkListener {
weak_messages: Arc::downgrade(&self.messages),
}
}
/// If the given message was received, remove the first occurrence of it and return true.
///
/// ```
/// use all_is_cubes::listen::{Listener, Sink};
///
/// let sink = Sink::new();
/// sink.listener().receive(2);
/// assert!(!sink.take_equal(1)); // No match
/// assert!(sink.take_equal(2)); // Match
/// assert!(!sink.take_equal(2)); // Now removed
/// ```
///
/// TODO: This is never used and therefore a candidate for removal.
pub fn take_equal(&self, message: M) -> bool
where
M: Eq,
{
let mut queue = self.messages.write().unwrap();
if let Some(index) = queue
.iter()
.enumerate()
.filter_map(|(i, m)| (*m == message).then_some(i))
.next()
{
queue.remove(index);
true
} else {
false
}
}
/// Remove and return all messages returned so far.
///
/// ```
/// use all_is_cubes::listen::{Listener, Sink};
///
/// let sink = Sink::new();
/// sink.listener().receive(1);
/// sink.listener().receive(2);
/// assert_eq!(sink.drain(), vec![1, 2]);
/// sink.listener().receive(3);
/// assert_eq!(sink.drain(), vec![3]);
/// ```
pub fn drain(&self) -> Vec<M> {
self.messages.write().unwrap().drain(..).collect()
}
}
impl<M> Listener<M> for SinkListener<M> {
fn receive(&self, message: M) {
if let Some(cell) = self.weak_messages.upgrade() {
cell.write().unwrap().push_back(message);
}
}
fn alive(&self) -> bool {
self.weak_messages.strong_count() > 0
}
}
impl<M> Clone for SinkListener<M> {
fn clone(&self) -> Self {
Self {
weak_messages: self.weak_messages.clone(),
}
}
}
impl<M> Default for Sink<M>
where
M: Send + Sync,
{
// This implementation cannot be derived because we do not want M: Default
fn default() -> Self {
Self::new()
}
}
/// A [`Listener`] destination which only stores a single flag indicating if any messages
/// were received.
pub struct DirtyFlag {
flag: Arc<AtomicBool>,
}
impl fmt::Debug for DirtyFlag {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("DirtyFlag")
.field(&self.flag.load(Ordering::Relaxed))
.finish()
}
}
/// [`DirtyFlag::listener()`] implementation.
#[derive(Clone, Debug)]
pub struct DirtyFlagListener {
weak_flag: Weak<AtomicBool>,
}
impl DirtyFlag {
/// Constructs a new [`DirtyFlag`] with the given initial value.
pub fn new(value: bool) -> Self {
Self {
flag: Arc::new(AtomicBool::new(value)),
}
}
/// Constructs a new [`DirtyFlag`] with the given initial value and call
/// [`Listen::listen()`] with its listener.
///
/// This is a convenience for calling `new()` followed by `listener()`.
pub fn listening(value: bool, source: impl Listen) -> Self {
let new_self = Self::new(value);
source.listen(new_self.listener());
new_self
}
/// Returns a [`Listener`] which will set this flag to [`true`] when it receives any
/// message.
pub fn listener(&self) -> DirtyFlagListener {
DirtyFlagListener {
weak_flag: Arc::downgrade(&self.flag),
}
}
/// Returns the flag value, setting it to [`false`] at the same time.
pub fn get_and_clear(&self) -> bool {
self.flag.swap(false, Ordering::Acquire)
}
/// Set the flag value to [`true`].
///
/// Usually a [`DirtyFlagListener`] is used instead of this, but it may be useful
/// in complex situations.
pub fn set(&self) {
self.flag.store(true, Ordering::Relaxed);
}
}
impl<M> Listener<M> for DirtyFlagListener {
fn receive(&self, _message: M) {
if let Some(cell) = self.weak_flag.upgrade() {
cell.store(true, Ordering::Release);
}
}
fn alive(&self) -> bool {
self.weak_flag.strong_count() > 0
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::listen::Notifier;
#[test]
fn null_alive() {
let notifier: Notifier<()> = Notifier::new();
notifier.listen(NullListener);
assert_eq!(notifier.count(), 0);
}
#[test]
fn sink_alive() {
let notifier: Notifier<()> = Notifier::new();
let sink = Sink::new();
notifier.listen(sink.listener());
assert_eq!(notifier.count(), 1);
drop(sink);
assert_eq!(notifier.count(), 0);
}
#[test]
fn dirty_flag_alive() {
let notifier: Notifier<()> = Notifier::new();
let flag = DirtyFlag::new(false);
notifier.listen(flag.listener());
assert_eq!(notifier.count(), 1);
drop(flag);
assert_eq!(notifier.count(), 0);
}
#[test]
fn dirty_flag_debug() {
assert_eq!(format!("{:?}", DirtyFlag::new(false)), "DirtyFlag(false)");
assert_eq!(format!("{:?}", DirtyFlag::new(true)), "DirtyFlag(true)");
let dirtied = DirtyFlag::new(false);
dirtied.listener().receive(());
assert_eq!(format!("{dirtied:?}"), "DirtyFlag(true)");
}
}