Struct PaneRecording 

pub struct PaneRecording { /* private fields */ }

State of a per-pane recording. Cheap when disabled — the on_bytes hook hits a single boolean check before deciding whether to deep-copy the chunk.

Implementations

impl PaneRecording

pub fn new(max_events: usize) -> Self

pub fn enable(&self, cols: u16, rows: u16)

Begin (or restart) recording. Clears prior events; stamps the start instant; remembers the pane dimensions for the cast header.

pub fn disable(&self)

Stop recording. Retains captured events so an operator can export them after stopping; a subsequent enable() clears + restarts.

pub fn epoch_anchor(&self) -> Option<u64>

Wall-clock start of the current recording, unix epoch ms.

The join key for anything stamped in epoch time. Self::read_around takes ms since enable(), so a caller holding an epoch timestamp must convert through this anchor:

rel_ms = epoch_ms.saturating_sub(anchor)

Passing an epoch timestamp straight to read_around is off by ~1.7e12 ms and silently returns the buffer tail — it does not error, which is why this accessor exists rather than leaving callers to guess.

pub fn is_enabled(&self) -> bool

Whether recording is currently capturing new events.

pub fn event_count(&self) -> usize

Number of currently-buffered events.

pub fn push(&self, bytes: &[u8])

Append a PTY chunk. Cheap no-op when recording is disabled. Ring-evicts the oldest event if the cap is hit.

pub fn to_cast_json(&self) -> String

Export as asciinema v2 .cast (JSON-lines). The first line is the header object; every subsequent line is [t_seconds, "o", "<utf-8 chunk>"]. Returns the full string ready to write to disk or pipe to asciinema play.

pub fn read_around(&self, ts_ms: u64, limit: usize) -> Vec<PaneEvent>

Read the events at (or just before) a given ts_ms — returns up to limit events nearest to the cursor for the time-travel scrubber. Lets a replay renderer seek without re-reading the full recording.

Trait Implementations

impl Default for PaneRecording

fn default() -> Self

Returns the “default value” for a type.