trapdoor 0.1.0

Data structure for collecting and reading in separate cells.
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

//! Data structure that accumulates data in separate cells which allows for
//! minimal (I think?) friction between taking accumulated data while storing
//! new data continuously.

use self::raw::RawTrapdoor;

mod raw;

/// A trapdoor.
pub struct Trapdoor<T> {
    raw: RawTrapdoor<T>,
}

impl<T> Trapdoor<T> {
    /// Create a new trapdoor.
    pub const fn new() -> Self {
        Self {
            raw: RawTrapdoor::new(),
        }
    }

    /// Take a collection from the trapdoor.
    pub fn take(&self) -> Vec<T> {
        self.raw.take()
    }

    /// Insert a value in the trapdoor.
    pub fn insert(&self, value: T) {
        self.raw.insert(value)
    }
}

impl<T> Default for Trapdoor<T> {
    /// Create a new, default trapdoor.
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod test {
    use crate::Trapdoor;

    #[test]
    fn test_take_insert() {
        let trapdoor = Trapdoor::new();

        assert_eq!(trapdoor.take().len(), 0);

        for i in 0..43 {
            trapdoor.insert(i);
        }

        let col = trapdoor.take();
        assert_eq!(col.len(), 43);
        assert_eq!(col.last(), Some(&42));
    }
}