aboutsummaryrefslogtreecommitdiffstats
path: root/src/reader.rs
blob: 3426dcb9b23465f461bf703faa0e79eb09929e3a (plain) (blame)
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
use futures_lite::io::AsyncReadExt as _;

/// Reads ttyrec frames from a [`futures_lite::io::AsyncRead`] instance.
pub struct Reader<T: futures_lite::io::AsyncRead> {
    input: T,
    parser: crate::Parser,
    buf: [u8; 4096],
}

impl<T: futures_lite::io::AsyncRead + std::marker::Unpin + Send> Reader<T> {
    /// Creates a new [`Reader`](Self) from a [`futures_lite::io::AsyncRead`]
    /// instance.
    pub fn new(input: T) -> Self {
        Self {
            input,
            parser: crate::Parser::new(),
            buf: [0; 4096],
        }
    }

    /// Returns the next parsed frame from the input stream.
    ///
    /// # Errors
    /// * [`Error::EOF`](crate::Error::EOF): The input stream has been closed.
    /// * [`Error::Read`](crate::Error::Read): There was an error reading from
    /// the input stream.
    // these unwraps aren't reachable
    #[allow(clippy::missing_panics_doc)]
    pub async fn read_frame(&mut self) -> crate::Result<crate::Frame> {
        loop {
            if let Some(frame) = self.parser.next_frame() {
                return Ok(frame);
            }
            let bytes = self
                .input
                .read(&mut self.buf)
                .await
                .map_err(|source| crate::Error::Read { source })?;
            if bytes == 0 {
                return Err(crate::Error::EOF);
            }
            self.parser.add_bytes(
                // read() returning a value means that that many bytes are
                // guaranteed to be available
                &self.buf[..bytes],
            );
        }
    }

    /// How much the timestamps in this file should be offset by.
    ///
    /// See [`Parser::offset`](crate::Parser::offset).
    pub fn offset(&self) -> Option<std::time::Duration> {
        self.parser.offset()
    }
}