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
|
/// Creates ttyrec frames.
///
/// A ttyrec file is a stream of concatenated frames. This struct creates
/// [`Frame`](crate::Frame) objects, which can be serialized to bytes using
/// their `try_from` implementation, and then a ttyrec file can be generated
/// by concatenating those byte strings.
#[derive(Debug, Clone)]
pub struct Creator {
base_time: Option<std::time::Instant>,
}
impl Creator {
/// Creates a new [`Creator`] instance.
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Returns a new [`Frame`](crate::Frame) object containing the given
/// data.
///
/// Equivalent to calling [`frame_at`](Self::frame_at) and passing
/// [`std::time::Instant::now()`] as the `cur_time` parameter.
pub fn frame(&mut self, data: &[u8]) -> crate::frame::Frame {
self.frame_at(std::time::Instant::now(), data)
}
/// Returns a new [`Frame`](crate::Frame) object containing the given data
/// at the given time.
///
/// Note that this is not guaranteed to do the correct thing unless the
/// `cur_time` parameters given in each [`frame_at`](Self::frame_at) call
/// are non-decreasing.
#[allow(clippy::missing_panics_doc)]
pub fn frame_at(
&mut self,
cur_time: std::time::Instant,
data: &[u8],
) -> crate::frame::Frame {
// this is triggering incorrectly - the code transformation it
// suggests doesn't work due to lifetime issues
#[allow(clippy::option_if_let_else)]
let base_time = if let Some(base_time) = &self.base_time {
base_time
} else {
self.base_time = Some(cur_time);
// this unwrap is safe because we just set the value to Some
self.base_time.as_ref().unwrap()
};
crate::frame::Frame {
time: cur_time - *base_time,
data: data.to_vec(),
}
}
}
impl Default for Creator {
fn default() -> Self {
Self { base_time: None }
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_basic() {
let mut creator = Creator::new();
let base_time = std::time::Instant::now();
let zero_frame: Vec<u8> =
TryFrom::try_from(creator.frame_at(base_time, b"")).unwrap();
assert_eq!(zero_frame, vec![0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
let data_frame: Vec<u8> = TryFrom::try_from(creator.frame_at(
base_time + std::time::Duration::new(38, 123_456_000),
b"\x1b[2Jfoobar",
))
.unwrap();
assert_eq!(
data_frame,
vec![
38, 0, 0, 0, 64, 226, 1, 0, 10, 0, 0, 0, 27, 91, 50, 74, 102,
111, 111, 98, 97, 114,
],
);
}
}
|
