futures-test 0.3.3

Common utilities for testing components built off futures-rs.
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

use futures_task::{FutureObj, Spawn, SpawnError};
use std::cell::{Ref, RefCell};

/// An implementation of [`Spawn`](futures_task::Spawn) that records
/// any [`Future`](futures_core::future::Future)s spawned on it.
///
/// # Examples
///
/// ```
/// use futures::task::SpawnExt;
/// use futures_test::task::RecordSpawner;
///
/// let recorder = RecordSpawner::new();
/// recorder.spawn(async { }).unwrap();
/// assert_eq!(recorder.spawned().len(), 1);
/// ```
#[derive(Debug, Default)]
pub struct RecordSpawner {
    spawned: RefCell<Vec<FutureObj<'static, ()>>>,
}

impl RecordSpawner {
    /// Create a new instance
    pub fn new() -> Self {
        Default::default()
    }

    /// Inspect any futures that were spawned onto this [`Spawn`].
    pub fn spawned(&self) -> Ref<'_, Vec<FutureObj<'static, ()>>> {
        self.spawned.borrow()
    }
}

impl Spawn for RecordSpawner {
    fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError> {
        self.spawned.borrow_mut().push(future);
        Ok(())
    }
}