rxrust 1.0.0-rc.4

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
//! Flattens Higher-Order Observables by merging inner observable emissions.

use std::collections::VecDeque;

use crate::{
  context::{Context, RcDerefMut},
  observable::{CoreObservable, ObservableType},
  observer::Observer,
  subscription::{DynamicSubscriptions, IntoBoxedSubscription},
};
/// Flattens a Higher-Order Observable (an observable that emits observables).
///
/// Subscribes to inner observables as they arrive, up to `concurrent` limit.
/// Excess observables are queued and subscribed when slots become available.
///
/// # Examples
///
/// ```
/// use rxrust::prelude::*;
///
/// // Basic usage - flatten nested observables
/// let mut result = Vec::new();
/// Local::from_iter([Local::from_iter([1, 2]), Local::from_iter([3, 4])])
///   .merge_all(usize::MAX)
///   .subscribe(|v| result.push(v));
/// assert_eq!(result, vec![1, 2, 3, 4]);
/// ```
///
/// # Concurrency Control
///
/// Use `concurrent` to limit simultaneous inner subscriptions:
/// - `usize::MAX`: Unlimited concurrency (subscribe to all immediately)
/// - `1`: Sequential processing (`concat_all` behavior)
/// - `n`: At most `n` concurrent inner subscriptions
#[derive(Clone)]
pub struct MergeAll<S> {
  pub source: S,
  pub concurrent: usize,
}

/// Shared state for MergeAll observers
#[doc(hidden)]
pub struct MergeAllState<O, InnerObs> {
  observer: Option<O>,
  /// Queue of pending inner observables when at concurrent limit
  pending_observables: VecDeque<InnerObs>,
  /// Number of currently active inner subscriptions
  subscribed: usize,
  /// Maximum concurrent inner subscriptions
  concurrent: usize,
  /// Whether the outer observable has completed
  outer_completed: bool,
}

impl<O, InnerObs> MergeAllState<O, InnerObs> {
  /// Checks if the observer is closed.
  /// Used by both inner and outer observers' `is_closed` implementation.
  fn observer_is_closed<Item, Err>(&self) -> bool
  where
    O: Observer<Item, Err>,
  {
    self.observer.as_ref().is_none_or(O::is_closed)
  }
}

#[doc(hidden)]
#[derive(Clone)]
pub struct MergeAllOuterObserver<P, SubState> {
  state: P,
  sub_state: SubState,
}

#[doc(hidden)]
#[derive(Clone)]
pub struct MergeAllInnerObserver<P, SubState> {
  state: P,
  sub_state: SubState,
  /// ID of this observer's subscription in DynamicSubscriptions
  subscription_id: usize,
  /// Function pointer to subscribe to queued inner observables
  subscribe_fn: fn(P, SubState),
}

/// Subscription handle returned by `merge_all`.
///
/// Unsubscribing cancels both the outer subscription and all active inner
/// subscriptions.
pub type MergeAllSubscription<SrcUnsub, SubState> =
  crate::subscription::SourceWithDynamicSubs<SrcUnsub, SubState>;

impl<S> ObservableType for MergeAll<S>
where
  S: ObservableType,
  for<'a> S::Item<'a>: Context<Inner: ObservableType>,
{
  type Item<'a>
    = <<S::Item<'a> as Context>::Inner as ObservableType>::Item<'a>
  where
    Self: 'a;
  type Err = S::Err;
}

/// Type alias for subscription state (using DynamicSubscriptions)
type RcSubscriptions<C> =
  <C as Context>::RcMut<DynamicSubscriptions<<C as Context>::BoxedSubscription>>;

/// CoreObservable implementation for MergeAll
///
/// Inner observables must be Context-wrapped (like `Local<FromIter<...>>`).
/// The Context is stripped via `into_inner()` when subscribing to ensure
/// all inner subscriptions use the outer Context's execution environment.
impl<S, C, InnerObs> CoreObservable<C> for MergeAll<S>
where
  C: Context,
  S: for<'a> CoreObservable<
      C::With<
        MergeAllOuterObserver<
          C::RcMut<MergeAllState<C::Inner, InnerObs>>,
          C::RcMut<DynamicSubscriptions<C::BoxedSubscription>>,
        >,
      >,
      Item<'a>: Context<Inner = InnerObs>,
    >,
  InnerObs: ObservableType,
{
  type Unsub = MergeAllSubscription<S::Unsub, RcSubscriptions<C>>;

  fn subscribe(self, context: C) -> Self::Unsub {
    let rc_sub_state: RcSubscriptions<C> = C::RcMut::from(DynamicSubscriptions::default());

    let ctx = context.transform(|observer| {
      let state = C::RcMut::from(MergeAllState {
        observer: Some(observer),
        pending_observables: VecDeque::new(),
        subscribed: 0,
        concurrent: self.concurrent,
        outer_completed: false,
      });
      MergeAllOuterObserver { state, sub_state: rc_sub_state.clone() }
    });

    let src_unsub = self.source.subscribe(ctx);
    crate::subscription::SourceWithDynamicSubs::new(src_unsub, rc_sub_state)
  }
}

impl<Item, Err, O, InnerObs, RcState, RcUnsubs, DynUnsub> Observer<Item, Err>
  for MergeAllInnerObserver<RcState, RcUnsubs>
where
  O: Observer<Item, Err>,
  RcState: RcDerefMut<Target = MergeAllState<O, InnerObs>> + Clone,
  RcUnsubs: RcDerefMut<Target = DynamicSubscriptions<DynUnsub>> + Clone,
{
  fn next(&mut self, value: Item) {
    let mut state = self.state.rc_deref_mut();
    if let Some(ref mut observer) = state.observer {
      observer.next(value);
    }
  }

  fn error(self, err: Err) {
    let mut state = self.state.rc_deref_mut();
    if let Some(observer) = state.observer.take() {
      observer.error(err);
    }
  }

  fn complete(self) {
    // Remove this subscription from the collection
    self
      .sub_state
      .rc_deref_mut()
      .remove(self.subscription_id);

    let mut state = self.state.rc_deref_mut();
    // Subscribe to next queued observable if available
    if !state.pending_observables.is_empty() {
      drop(state);
      (self.subscribe_fn)(self.state.clone(), self.sub_state.clone());
    } else {
      state.subscribed = state.subscribed.saturating_sub(1);
      // Complete downstream if outer completed and no more active subscriptions
      if state.subscribed == 0
        && state.outer_completed
        && let Some(observer) = state.observer.take()
      {
        observer.complete();
      }
    }
  }

  fn is_closed(&self) -> bool {
    self
      .state
      .rc_deref()
      .observer_is_closed::<Item, Err>()
  }
}

/// Observer implementation for outer observable
///
/// Receives Context-wrapped inner observables and strips the Context via
/// `into_inner()` before storing them. This ensures all inner subscriptions
/// use the outer Context's execution environment.
impl<Ctx, Err, O, RcState, RcUnsubs> Observer<Ctx, Err> for MergeAllOuterObserver<RcState, RcUnsubs>
where
  Ctx: Context<
    Inner: CoreObservable<
      Ctx::With<MergeAllInnerObserver<RcState, RcUnsubs>>,
      Unsub: IntoBoxedSubscription<Ctx::BoxedSubscription>,
    >,
  >,
  O: for<'a> Observer<<Ctx::Inner as ObservableType>::Item<'a>, Err>,
  RcState: RcDerefMut<Target = MergeAllState<O, Ctx::Inner>> + Clone,
  RcUnsubs: RcDerefMut<Target = DynamicSubscriptions<Ctx::BoxedSubscription>> + Clone,
{
  fn next(&mut self, inner_ctx_obs: Ctx) {
    // Strip the Context to get the raw CoreObservable
    let inner_obs = inner_ctx_obs.into_inner();
    let mut state = self.state.rc_deref_mut();
    state.pending_observables.push_back(inner_obs);
    if state.subscribed < state.concurrent {
      state.subscribed += 1;
      drop(state);
      Self::do_next_subscribe::<Ctx, _, _>(self.state.clone(), self.sub_state.clone());
    }
  }

  fn error(self, err: Err) {
    let mut state = self.state.rc_deref_mut();
    if let Some(observer) = state.observer.take() {
      observer.error(err);
    }
  }

  fn complete(self) {
    let mut state = self.state.rc_deref_mut();
    state.outer_completed = true;
    // Complete downstream if no active subscriptions and no pending observables
    if state.subscribed == 0
      && state.pending_observables.is_empty()
      && let Some(observer) = state.observer.take()
    {
      observer.complete();
    }
  }

  fn is_closed(&self) -> bool { self.state.rc_deref().observer_is_closed() }
}

impl<RcState, RcUnsubs> MergeAllOuterObserver<RcState, RcUnsubs> {
  fn do_next_subscribe<Ctx, O, InnerObs>(state: RcState, sub_state: RcUnsubs)
  where
    Ctx: Context,
    RcState: RcDerefMut<Target = MergeAllState<O, InnerObs>> + Clone,
    RcUnsubs: RcDerefMut<Target = DynamicSubscriptions<Ctx::BoxedSubscription>> + Clone,
    InnerObs: CoreObservable<
        Ctx::With<MergeAllInnerObserver<RcState, RcUnsubs>>,
        Unsub: IntoBoxedSubscription<Ctx::BoxedSubscription>,
      >,
  {
    let inner_obs = state
      .rc_deref_mut()
      .pending_observables
      .pop_front();
    if let Some(inner_obs) = inner_obs {
      // Pre-allocate ID before creating observer
      let subscription_id = sub_state.rc_deref_mut().reserve_id();

      let inner_observer = MergeAllInnerObserver {
        state: state.clone(),
        sub_state: sub_state.clone(),
        subscription_id,
        subscribe_fn: Self::do_next_subscribe::<Ctx, _, _>,
      };

      let unsub = inner_obs.subscribe(Ctx::lift(inner_observer));
      let boxed_unsub = unsub.into_boxed();

      // Insert subscription with pre-allocated ID
      sub_state
        .rc_deref_mut()
        .insert(subscription_id, boxed_unsub);
    }
  }
}

#[cfg(test)]
mod tests {
  use std::{cell::RefCell, rc::Rc};

  use crate::prelude::*;

  #[rxrust_macro::test]
  fn test_merge_all_basic() {
    let result = Rc::new(RefCell::new(Vec::new()));
    let result_clone = result.clone();

    // Create observable of observables - no .into_inner() needed!
    Local::from_iter([Local::from_iter([1, 2]), Local::from_iter([3, 4])])
      .merge_all(usize::MAX)
      .subscribe(move |v| {
        result_clone.borrow_mut().push(v);
      });

    assert_eq!(*result.borrow(), vec![1, 2, 3, 4]);
  }

  #[rxrust_macro::test]
  fn test_concat_all() {
    let result = Rc::new(RefCell::new(Vec::new()));
    let result_clone = result.clone();

    // concat_all is merge_all(1) - sequential subscription
    Local::from_iter([Local::from_iter([1, 2]), Local::from_iter([3, 4])])
      .concat_all()
      .subscribe(move |v| {
        result_clone.borrow_mut().push(v);
      });

    assert_eq!(*result.borrow(), vec![1, 2, 3, 4]);
  }

  #[rxrust_macro::test]
  fn test_merge_all_empty() {
    let result = Rc::new(RefCell::new(Vec::<i32>::new()));
    let result_clone = result.clone();
    let completed = Rc::new(RefCell::new(false));
    let completed_clone = completed.clone();

    Local::from_iter(Vec::<Local<FromIter<std::vec::IntoIter<i32>>>>::new())
      .merge_all(usize::MAX)
      .on_complete(move || {
        *completed_clone.borrow_mut() = true;
      })
      .subscribe(move |v| {
        result_clone.borrow_mut().push(v);
      });

    assert!(result.borrow().is_empty());
    assert!(*completed.borrow());
  }

  #[rxrust_macro::test(local)]
  async fn test_merge_all_subscription_stays_open_while_inner_active() {
    use std::time::Duration;

    use crate::{scheduler::LocalScheduler, subscription::Subscription};

    let values = Rc::new(RefCell::new(Vec::new()));
    let values_c = values.clone();
    let completed = Rc::new(RefCell::new(false));
    let completed_c = completed.clone();

    let subscription = Local::of(Local::of(42).delay_subscription(Duration::from_millis(20)))
      .merge_all(usize::MAX)
      .on_complete(move || *completed_c.borrow_mut() = true)
      .subscribe(move |v| values_c.borrow_mut().push(v));

    assert!(!subscription.is_closed());
    assert!(values.borrow().is_empty());
    assert!(!*completed.borrow());

    LocalScheduler
      .sleep(Duration::from_millis(40))
      .await;

    assert_eq!(*values.borrow(), vec![42]);
    assert!(*completed.borrow());
    assert!(subscription.is_closed());
  }

  #[rxrust_macro::test]
  fn test_merge_all_concurrency() {
    let result = Rc::new(RefCell::new(Vec::new()));
    let result_clone = result.clone();

    let mut s1 = Local::subject();
    let mut s2 = Local::subject();
    let mut s3 = Local::subject();

    let mut outer = Local::subject();

    let _subscription = outer.clone().merge_all(2).subscribe(move |v| {
      result_clone.borrow_mut().push(v);
    });

    // Pass Context-wrapped subjects (Local<Subject>)
    outer.next(s1.clone());
    outer.next(s2.clone());
    outer.next(s3.clone()); // queued

    s1.next(1);
    s2.next(2);
    s3.next(3); // Should be lost since s3 is queued

    assert_eq!(*result.borrow(), vec![1, 2]);

    s1.complete(); // s3 should be subscribed now

    s3.next(4);
    assert_eq!(*result.borrow(), vec![1, 2, 4]);
  }

  #[rxrust_macro::test]
  fn test_merge_all_inner_error() {
    let error_called = Rc::new(RefCell::new(false));
    let error_called_clone = error_called.clone();

    let s1 = Local::subject();
    let mut outer = Local::subject();

    outer
      .clone()
      .merge_all(usize::MAX)
      .on_error(move |_| {
        *error_called_clone.borrow_mut() = true;
      })
      .subscribe(|_: i32| {});

    // Pass Context-wrapped subject
    outer.next(s1.clone());
    s1.error(());

    assert!(*error_called.borrow());
  }

  #[rxrust_macro::test]
  fn test_merge_all_outer_error() {
    let error_called = Rc::new(RefCell::new(false));
    let error_called_clone = error_called.clone();

    let outer = Local::subject();
    let inner_dummy = Local::subject::<i32, ()>();

    let mut outer_clone = outer.clone();

    outer
      .clone()
      .merge_all(usize::MAX)
      .on_error(move |_| {
        *error_called_clone.borrow_mut() = true;
      })
      .subscribe(|_| {});

    // Force type inference with Context-wrapped subject
    if false {
      outer_clone.next(inner_dummy.clone());
    }

    outer.error(());

    assert!(*error_called.borrow());
  }

  #[rxrust_macro::test]
  fn test_merge_all_unsubscribe() {
    let result = Rc::new(RefCell::new(Vec::new()));
    let result_clone = result.clone();

    let mut s1 = Local::subject();
    let mut s2 = Local::subject();
    let mut outer = Local::subject();

    let subscription = outer
      .clone()
      .merge_all(usize::MAX)
      .subscribe(move |v| {
        result_clone.borrow_mut().push(v);
      });

    // Pass Context-wrapped subjects
    outer.next(s1.clone());
    outer.next(s2.clone());

    s1.next(1);
    s2.next(2);

    assert_eq!(*result.borrow(), vec![1, 2]);

    subscription.unsubscribe();

    s1.next(3);
    s2.next(4);

    assert_eq!(*result.borrow(), vec![1, 2]);
  }
}