logss 0.0.4

A simple command line tool that helps you visualize an input stream of text.
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

/// Generic CircularBuffer where oldest element are overwritten
/// by the new ones.
///
/// Usage example:
/// ```
/// extern crate logss;
/// use logss::cb;
/// let mut cb:cb::CircularBuffer<i32> = cb::CircularBuffer::new(3);
/// cb.push(1);
/// cb.push(2);
/// cb.push(3);
/// cb.push(4);
/// assert_eq!(cb.buffer, vec![4, 2, 3]);
///
/// // Notice the order that `ordered_clone` returns
/// let cb2 = cb.ordered_clone();
/// assert_eq!(cb2.buffer, vec![2, 3, 4]);
/// ```
#[derive(Debug)]
pub struct CircularBuffer<T> {
    /// Actual buffer
    pub buffer: Vec<T>,
    /// index that keeps track of the writes
    write_index: usize,
}

impl<T> CircularBuffer<T>
where
    T: Clone,
{
    /// Constructs a new instance of [`CircularBuffer`].
    pub fn new(capacity: usize) -> Self {
        Self {
            buffer: Vec::with_capacity(capacity),
            write_index: 0,
        }
    }

    /// Returns the buffer capacity
    pub fn capacity(&self) -> usize {
        self.buffer.capacity()
    }

    /// Returns the buffer length
    pub fn len(&self) -> usize {
        self.buffer.len()
    }

    /// Returns ttue if the buffer is empty
    pub fn is_empty(&self) -> bool {
        self.buffer.is_empty()
    }

    /// Push an element into the buffer
    pub fn push(&mut self, element: T) {
        let capacity = self.capacity();
        let len = self.len();

        if len < capacity {
            self.buffer.push(element);
        } else {
            self.buffer[self.write_index % capacity] = element;
        }

        self.write_index += 1;
    }

    /// Clones and returns a new instance of [`CircularBuffer`] in the write order
    pub fn ordered_clone(&self) -> Self {
        let capacity = self.capacity();
        let len = self.len();
        let mut cb = Self::new(capacity);

        if len < capacity {
            cb.buffer.clone_from(&self.buffer);
        } else {
            let index_position = self.write_index % capacity;
            cb.buffer.extend_from_slice(&self.buffer[index_position..]);
            cb.buffer.extend_from_slice(&self.buffer[..index_position]);
        }

        cb
    }

    pub fn reset(&mut self) {
        self.buffer.clear();
        self.write_index = 0;
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn circular_buffer() {
        let mut cb: CircularBuffer<i32> = CircularBuffer::new(3);
        assert_eq!(cb.capacity(), 3);
        assert_eq!(cb.len(), 0);
        assert!(cb.is_empty());

        cb.push(1);
        assert_eq!(cb.buffer, vec![1]);
        assert_eq!(cb.len(), 1);
        assert!(!cb.is_empty());

        cb.push(2);
        cb.push(3);
        assert_eq!(cb.buffer, vec![1, 2, 3]);
        assert_eq!(cb.len(), 3);

        cb.push(4);
        assert_eq!(cb.buffer, vec![4, 2, 3]);
        assert_eq!(cb.len(), 3);
    }

    #[test]
    fn circular_buffer_clone() {
        let mut cb: CircularBuffer<i32> = CircularBuffer::new(3);
        cb.push(1);
        cb.push(2);
        cb.push(3);
        cb.push(4);

        let cb2 = cb.ordered_clone();
        assert_eq!(cb2.buffer, vec![2, 3, 4]);
    }
}