rxrust 0.7.2

A Rust implementation of Reactive Extensions.
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
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
use crate::observer::{
  observer_complete_proxy_impl, ObserverComplete, ObserverError, ObserverNext,
};
use crate::prelude::*;
use crate::util;
use std::cell::RefCell;
use std::rc::Rc;
use std::sync::{Arc, Mutex};

#[derive(Default, Clone)]
pub struct Subject<O, S> {
  pub(crate) observers: O,
  pub(crate) subscription: S,
}

#[derive(Clone, Copy)]
pub struct SubjectValue<T>(T);

pub struct SubjectMutRefValue<T>(*mut T);

impl<T> Clone for SubjectMutRefValue<T> {
  fn clone(&self) -> Self { *self }
}

impl<T> Copy for SubjectMutRefValue<T> {}

pub struct LocalSubjectObserver<'a, Item, Err>(
  Rc<RefCell<Vec<Box<dyn Publisher<Item, Err> + 'a>>>>,
);
pub type LocalSubject<'a, Item, Err> =
  Subject<LocalSubjectObserver<'a, Item, Err>, LocalSubscription>;

type SharedPublishers<Item, Err> =
  Arc<Mutex<Vec<Box<dyn Publisher<Item, Err> + Send + Sync>>>>;

pub type SharedSubject<Item, Err> =
  Subject<SharedPublishers<Item, Err>, SharedSubscription>;

impl<'a, Item, Err> LocalSubject<'a, Item, Err> {
  pub fn local() -> Self {
    Subject {
      observers: LocalSubjectObserver(Rc::new(RefCell::new(vec![]))),
      subscription: LocalSubscription::default(),
    }
  }
}

impl<Item, Err> SharedSubject<Item, Err> {
  pub fn shared() -> Self {
    Subject {
      observers: Arc::new(Mutex::new(vec![])),
      subscription: SharedSubscription::default(),
    }
  }
}
impl<Item, Err> IntoShared for SharedSubject<Item, Err>
where
  Item: 'static,
  Err: 'static,
{
  type Shared = Self;
  #[inline(always)]
  fn to_shared(self) -> Self::Shared { self }
}

impl<'a, Item, Err> IntoShared
  for LocalSubject<'a, SubjectValue<Item>, SubjectValue<Err>>
where
  Item: 'static,
  Err: 'static,
{
  type Shared = Subject<SharedPublishers<Item, Err>, SharedSubscription>;
  fn to_shared(self) -> Self::Shared {
    let Self {
      observers,
      subscription,
    } = self;
    let observers = util::unwrap_rc_ref_cell(
      observers.0,
      "Cannot convert a `LocalSubscription` to `SharedSubscription` \
       when it referenced by other.",
    );
    let observers = if observers.is_empty() {
      Arc::new(Mutex::new(vec![]))
    } else {
      panic!(
        "Cannot convert a `LocalSubscription` to `SharedSubscription` \
         when it subscribed."
      )
    };
    let subscription = subscription.to_shared();
    Subject {
      observers,
      subscription,
    }
  }
}

macro local_subject_raw_subscribe_impl($o: ident,$u: ident) {
  type Unsub = $u;
  fn raw_subscribe(mut self, subscriber: Subscriber<$o, $u>) -> Self::Unsub {
    let subscription = subscriber.subscription.clone();
    self.subscription.add(subscription.clone());
    self
      .observers
      .0.borrow_mut()
      .push(Box::new(LocalSubjectSubscriber(subscriber)));
    subscription
  }
}

impl<'a, Item: Copy, Err: Copy, O, U> RawSubscribable<Subscriber<O, U>>
  for LocalSubject<'a, SubjectValue<Item>, SubjectValue<Err>>
where
  O: Observer<Item, Err> + 'a,
  U: SubscriptionLike + Clone + 'static,
{
  local_subject_raw_subscribe_impl!(O, U);
}

impl<'a, Item, Err: Copy, O, U> RawSubscribable<Subscriber<O, U>>
  for LocalSubject<'a, SubjectMutRefValue<Item>, SubjectValue<Err>>
where
  O: for<'r> Observer<&'r mut Item, Err> + 'a,
  U: SubscriptionLike + Clone + 'static,
{
  local_subject_raw_subscribe_impl!(O, U);
}

impl<'a, Item: Copy, Err, O, U> RawSubscribable<Subscriber<O, U>>
  for LocalSubject<'a, SubjectValue<Item>, SubjectMutRefValue<Err>>
where
  O: for<'r> Observer<Item, &'r mut Err> + 'a,
  U: SubscriptionLike + Clone + 'static,
{
  local_subject_raw_subscribe_impl!(O, U);
}

impl<'a, Item, Err, O, U> RawSubscribable<Subscriber<O, U>>
  for LocalSubject<'a, SubjectMutRefValue<Item>, SubjectMutRefValue<Err>>
where
  O: for<'r> Observer<&'r mut Item, &'r mut Err> + 'a,
  U: SubscriptionLike + Clone + 'static,
{
  local_subject_raw_subscribe_impl!(O, U);
}

impl<Item, Err, O, S> RawSubscribable<Subscriber<O, S>>
  for SharedSubject<Item, Err>
where
  S: IntoShared,
  O: IntoShared,
  O::Shared: Observer<Item, Err>,
  S::Shared: SubscriptionLike + Clone + 'static,
{
  type Unsub = S::Shared;
  fn raw_subscribe(mut self, subscriber: Subscriber<O, S>) -> Self::Unsub {
    let subscriber = subscriber.to_shared();
    let subscription = subscriber.subscription.clone();
    self.subscription.add(subscription.clone());
    self.observers.lock().unwrap().push(Box::new(subscriber));
    subscription
  }
}

impl<O, S> SubscriptionLike for Subject<O, S>
where
  S: SubscriptionLike,
{
  #[inline]
  fn unsubscribe(&mut self) { self.subscription.unsubscribe() }
  #[inline]
  fn is_closed(&self) -> bool { self.subscription.is_closed() }
  #[inline]
  fn inner_addr(&self) -> *const () { self.subscription.inner_addr() }
}

impl<O, S> Fork for Subject<O, S>
where
  Self: Clone,
{
  type Output = Self;
  fn fork(&self) -> Self::Output { self.clone() }
}

impl<Item, T> ObserverNext<Item> for Vec<T>
where
  Item: Copy,
  T: ObserverNext<Item> + SubscriptionLike,
{
  fn next(&mut self, value: Item) {
    self.drain_filter(|subscriber| {
      subscriber.next(value);
      subscriber.is_closed()
    });
  }
}

impl<Err, T> ObserverError<Err> for Vec<T>
where
  Err: Copy,
  T: ObserverError<Err> + SubscriptionLike,
{
  fn error(&mut self, err: Err) {
    self.iter_mut().for_each(|subscriber| {
      subscriber.error(err);
    });
    self.clear();
  }
}

impl<T> ObserverComplete for Vec<T>
where
  T: ObserverComplete,
{
  fn complete(&mut self) {
    self.iter_mut().for_each(|subscriber| {
      subscriber.complete();
    });
    self.clear();
  }
}

struct LocalSubjectSubscriber<T>(T);

impl<Item, T> ObserverNext<SubjectValue<Item>> for LocalSubjectSubscriber<T>
where
  T: ObserverNext<Item>,
{
  #[inline(always)]
  fn next(&mut self, value: SubjectValue<Item>) { self.0.next(value.0) }
}

impl<Err, T> ObserverError<SubjectValue<Err>> for LocalSubjectSubscriber<T>
where
  T: ObserverError<Err>,
{
  #[inline(always)]
  fn error(&mut self, value: SubjectValue<Err>) { self.0.error(value.0) }
}

impl<Item, T> ObserverNext<SubjectMutRefValue<Item>>
  for LocalSubjectSubscriber<T>
where
  T: for<'r> ObserverNext<&'r mut Item>,
{
  #[inline(always)]
  fn next(&mut self, value: SubjectMutRefValue<Item>) {
    // unsafe introduce
    // this unsafe code is safe because we just use it to emit item by mut ref
    // in LocalSubject. LocalSubject just pass item to downstream one by one and
    // never alias the mut ref.
    self.0.next(unsafe { &mut (*value.0) })
  }
}

impl<Err, T> ObserverError<SubjectMutRefValue<Err>>
  for LocalSubjectSubscriber<T>
where
  T: for<'r> ObserverError<&'r mut Err>,
{
  #[inline(always)]
  fn error(&mut self, value: SubjectMutRefValue<Err>) {
    // unsafe introduce
    // this unsafe code is safe because we just use it to emit error by mut ref
    // in LocalSubject. LocalSubject just pass error to downstream one by one
    // and never alias the mut ref.
    self.0.error(unsafe { &mut (*value.0) })
  }
}

observer_complete_proxy_impl!(LocalSubjectSubscriber<T>, T, 0, <T> );

impl<T> SubscriptionLike for LocalSubjectSubscriber<T>
where
  T: SubscriptionLike,
{
  #[inline(always)]
  fn unsubscribe(&mut self) { self.0.unsubscribe(); }
  #[inline(always)]
  fn is_closed(&self) -> bool { self.0.is_closed() }
  #[inline(always)]
  fn inner_addr(&self) -> *const () { self.0.inner_addr() }
}

impl<'a, Item: Copy, Err> ObserverNext<Item>
  for LocalSubjectObserver<'a, SubjectValue<Item>, Err>
{
  #[inline]
  fn next(&mut self, value: Item) { self.0.next(SubjectValue(value)) }
}

impl<'a, Item, Err> ObserverNext<&mut Item>
  for LocalSubjectObserver<'a, SubjectMutRefValue<Item>, Err>
{
  #[inline]
  fn next(&mut self, value: &mut Item) {
    self.0.next(SubjectMutRefValue(value))
  }
}

impl<'a, Item, Err: Copy> ObserverError<Err>
  for LocalSubjectObserver<'a, Item, SubjectValue<Err>>
{
  #[inline]
  fn error(&mut self, err: Err) { self.0.error(SubjectValue(err)) }
}

impl<'a, Item, Err> ObserverError<&mut Err>
  for LocalSubjectObserver<'a, Item, SubjectMutRefValue<Err>>
{
  #[inline]
  fn error(&mut self, err: &mut Err) { self.0.error(SubjectMutRefValue(err)) }
}

impl<'a, Item, Err> ObserverComplete for LocalSubjectObserver<'a, Item, Err> {
  #[inline]
  fn complete(&mut self) { self.0.complete(); }
}

impl<'a, Item, Err> Clone for LocalSubjectObserver<'a, Item, Err> {
  #[inline]
  fn clone(&self) -> Self { LocalSubjectObserver(self.0.clone()) }
}

impl<Item, S, O> ObserverNext<Item> for Subject<O, S>
where
  O: ObserverNext<Item>,
  S: SubscriptionLike,
{
  fn next(&mut self, value: Item) {
    if !self.subscription.is_closed() {
      self.observers.next(value)
    }
  }
}

impl<Err, S, O> ObserverError<Err> for Subject<O, S>
where
  O: ObserverError<Err>,
  S: SubscriptionLike,
{
  fn error(&mut self, err: Err) {
    if !self.subscription.is_closed() {
      self.observers.error(err);
      self.subscription.unsubscribe();
    };
  }
}

impl<S, O> ObserverComplete for Subject<O, S>
where
  O: ObserverComplete,
  S: SubscriptionLike,
{
  fn complete(&mut self) {
    if !self.subscription.is_closed() {
      self.observers.complete();
      self.subscription.unsubscribe();
    }
  }
}

#[cfg(test)]
mod test {
  use super::*;
  use crate::ops::FilterMap;

  #[test]
  fn emit_ref() {
    // emit ref
    let mut subject: LocalSubject<'_, _, ()> = Subject::local();
    subject.next(&1);

    let mut i = 1;
    // emit item by mut ref, emit error by value
    let mut subject = Subject::local();
    subject.fork().subscribe_err(|v: &mut _| *v = 100, |_| {});
    subject.next(&mut i);
    subject.error(1);
    assert_eq!(i, 100);

    // emit item by value, emit error by mut ref
    let mut subject = Subject::local();
    subject.fork().subscribe_err(|_| {}, |_: &mut _| {});
    subject.next(1);
    subject.error(&mut 1);
    // emit item by mut ref and emit error by mut ref
    let mut subject = Subject::local();
    subject.fork().subscribe_err(|_: &mut _| {}, |_: &mut _| {});
    subject.next(&mut 1);
    subject.error(&mut 1);
  }

  #[test]
  fn base_data_flow() {
    let mut i = 0;
    {
      let mut broadcast = Subject::local();
      broadcast.fork().subscribe(|v| i = v * 2);
      broadcast.next(1);
    }
    assert_eq!(i, 2);
  }

  #[test]
  #[should_panic]
  fn error() {
    let mut broadcast = Subject::local();
    broadcast
      .fork()
      .subscribe_err(|_: i32| {}, |e: _| panic!(e));
    broadcast.next(1);

    broadcast.error(&"should panic!");
  }

  #[test]
  fn unsubscribe() {
    let mut i = 0;

    {
      let mut subject = Subject::local();
      subject.fork().subscribe(|v| i = v).unsubscribe();
      subject.next(100);
    }

    assert_eq!(i, 0);
  }

  #[test]
  fn fork_and_shared() {
    let subject = Subject::shared();
    subject
      .fork()
      .to_shared()
      .fork()
      .to_shared()
      .subscribe(|_: &()| {});
  }

  #[test]
  fn empty_local_subject_can_convert_to_shared() {
    use crate::{ops::ObserveOn, scheduler::Schedulers};
    use std::sync::{Arc, Mutex};
    let value = Arc::new(Mutex::new(0));
    let c_v = value.clone();
    let mut subject = Subject::local().to_shared();
    subject.fork().observe_on(Schedulers::NewThread).subscribe(
      move |v: i32| {
        *value.lock().unwrap() = v;
      },
    );

    subject.next(100);
    std::thread::sleep(std::time::Duration::from_millis(1));

    assert_eq!(*c_v.lock().unwrap(), 100);
  }

  #[test]
  fn emit_mut_ref_life_time() {
    let mut i = 1;
    {
      // emit mut ref
      let mut subject = Subject::local();
      subject
        .fork()
        .filter_map((|v| Some(v)) as for<'r> fn(&'r mut _) -> Option<&'r mut _>)
        .subscribe(|_: &mut i32| {
          i = 100;
        });
      subject.next(&mut 1);
    }
    assert_eq!(i, 100);
  }

  #[test]
  fn subject_subscribe_subject() {
    let mut local = Subject::local();
    let local2 = Subject::local();
    local.fork().raw_subscribe(Subscriber {
      observer: local2.observers,
      subscription: local2.subscription,
    });
    local.next(1);
    local.error(2);
  }

  #[test]
  #[should_panic]
  fn convert_subscribed_local_subject_to_shared_should_panic() {
    let subject = Subject::local();
    subject.fork().subscribe(|_: i32| {});
    subject.to_shared();
  }
}