aboutsummaryrefslogtreecommitdiffstats
path: root/src/frame.rs
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-11-04 10:15:12 -0500
committerJesse Luehrs <doy@tozt.net>2019-11-04 10:17:56 -0500
commit7c8fa35807d3b3cda991715d9735e151367b2fb6 (patch)
tree2e492ae140a2d343c680cec15fb28090d52bf8de /src/frame.rs
parente7beaa60f8c246190a8d9089c66d546abadab577 (diff)
downloadttyrec-7c8fa35807d3b3cda991715d9735e151367b2fb6.tar.gz
ttyrec-7c8fa35807d3b3cda991715d9735e151367b2fb6.zip
track the time offset during parsing
Diffstat (limited to 'src/frame.rs')
-rw-r--r--src/frame.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/frame.rs b/src/frame.rs
index 17c6c5a..c617056 100644
--- a/src/frame.rs
+++ b/src/frame.rs
@@ -1,8 +1,9 @@
/// Represents a single ttyrec frame.
///
-/// Ttyrec files are a raw concatenation of frames. Note that the `time` field
-/// in each frame is the time since the start of the entire file, and it is
-/// invalid for the `time` fields in a ttyrec file to be decreasing.
+/// Ttyrec files are a raw concatenation of frames. Note that the timestamps
+/// in the frame are absolute timestamps, and only the difference between them
+/// is relevant. The base timestamp can be anything (common choices are 0 or
+/// the actual time that the frame was generated).
///
/// Frame objects are typically created via the `Creator`, `Parser`, or
/// `Reader` classes.