Struct InputRecorder 

pub struct InputRecorder<B> { /* private fields */ }

Wraps a backend and records every event it sees.

Works over a Backend, or any subset of Output/Input/Cursor: taps Input::poll_event to capture, while delegating everything else unchanged.

Recording starts immediately on construction; use handle (or the convenience start/pause/stop/ save methods on this type, which forward to it) to control capture and save it to a .rgrec file.

Examples

use retroglyph_core::backend::{Headless, Input};
use retroglyph_core::event::{Event, KeyCode, KeyEvent, KeyModifiers};
use retroglyph_recorder::InputRecorder;

let mut recorder = InputRecorder::new(Headless::new(10, 3));
recorder.push_event(Event::Key(KeyEvent::new(KeyCode::Char('a'), KeyModifiers::NONE)));
let event = recorder.poll_event(std::time::Duration::ZERO);
assert!(event.is_some());

let recording = recorder.stop();
assert_eq!(recording.len(), 1);

Implementations

impl<B: Output> InputRecorder<B>

pub fn new(inner: B) -> Self

Wraps inner, sizing the recording to inner’s current Output::size.

impl<B> InputRecorder<B>

pub fn handle(&self) -> RecorderHandle

A cloneable RecorderHandle onto this recorder’s shared state, for reaching in from another call stack (see RecorderHandle’s own docs).

pub fn start(&self)

RecorderHandle::start on this recorder’s own handle.

pub fn pause(&self)

RecorderHandle::pause on this recorder’s own handle.

pub fn snapshot(&self) -> InputRecording

RecorderHandle::snapshot on this recorder’s own handle.

pub fn stop(&self) -> InputRecording

RecorderHandle::stop on this recorder’s own handle.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

RecorderHandle::save on this recorder’s own handle.

Errors

Returns an error if path cannot be created or written to.

pub const fn inner(&self) -> &B

The wrapped backend, for anything not exposed through the decorator itself.

pub const fn inner_mut(&mut self) -> &mut B

The wrapped backend, mutably.

Trait Implementations

impl<B: Cursor> Cursor for InputRecorder<B>

fn set_cursor_visible(&mut self, visible: bool)

Show or hide the cursor.

fn set_cursor_position(&mut self, position: Pos)

Move the cursor to a position.

fn set_cursor_style(&mut self, style: CursorStyle)

Set the cursor’s shape (and blink behavior).

impl<B: Input> Input for InputRecorder<B>

fn poll_event(&mut self, timeout: Duration) -> Option<Event>

Poll for an input event, waiting up to timeout.

fn push_event(&mut self, event: Event)

Push an event into the backend’s event buffer.

impl<B: Output> Output for InputRecorder<B>

type Error = <B as Output>::Error

Error type returned by fallible operations.

fn draw<'a, I>(&mut self, content: I) -> Result<(), Self::Error>

where I: Iterator<Item = DrawCell<'a>>,

Draw changed cells to the output surface, layer 0 only.

fn draw_layers<'a, I>(&mut self, content: I) -> Result<(), Self::Error>

where I: Iterator<Item = DrawCell<'a>>,

Draw changed cells across all layers.

fn compositing(&self) -> Compositing

How this backend wants layers handed to draw_layers.

fn flush(&mut self) -> Result<(), Self::Error>

Flush buffered output to the display.

fn size(&self) -> Size

Return current display dimensions.

fn clear(&mut self) -> Result<(), Self::Error>

Clear the entire display.

fn resize(&mut self, size: Size)

Notify the backend of a resize to size, updating what size reports.