Struct SerialPane 

pub struct SerialPane { /* private fields */ }

Terminal-emulator-backed pane for serial data.

Wraps a vt100::Parser with a fixed scrollback budget. Use SerialPane::ingest to feed newly received bytes; SerialPane::screen exposes the current grid for rendering.

Implementations

impl SerialPane

pub const DEFAULT_SCROLLBACK_ROWS: usize = 10_000

Default scrollback capacity applied by SerialPane::new.

10,000 rows is enough for ~minutes of typical embedded debug output and keeps peak memory bounded (cell grid at 80 cols ≈ 80 bytes × 10_000 ≈ 800 KiB).

pub fn new(rows: u16, cols: u16) -> Self

Build a pane with the default scrollback capacity.

pub fn with_scrollback(rows: u16, cols: u16, scrollback_rows: usize) -> Self

Build a pane with an explicit scrollback capacity.

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

Feed bytes into the terminal emulator.

Safe to call with any arbitrary byte stream — invalid escape sequences are dropped by vt100.

pub fn screen(&self) -> &Screen

Reference to the current vt100 Screen.

The screen is mutable internally but exposed as & so callers can only read it; ingestion must go through SerialPane::ingest.

pub fn resize(&mut self, rows: u16, cols: u16)

Resize the emulator grid.

vt100 reflows accordingly — lines longer than the new width wrap; scrollback is preserved as-is.

pub const fn scrollback_rows(&self) -> usize

Scrollback row count configured for this pane.

pub fn scrollback_offset(&self) -> usize

Current scrollback offset from the live tail (0 = live).

A non-zero value means the rendered view is above the live tail by that many rows; new bytes continue to accumulate in the buffer but do not scroll the view until the user scrolls back down via SerialPane::scroll_down / SerialPane::scroll_to_bottom.

pub fn is_scrolled(&self) -> bool

True when the view is above the live tail.

Consumers (e.g. the top-bar renderer) use this as the “should I show the [SCROLL ↑N] indicator?” predicate.

pub fn scroll_up(&mut self, lines: usize)

Scroll up by lines (toward older content).

Clamped to the configured scrollback capacity so extreme input values (e.g. usize::MAX) do not overflow. vt100 also clamps internally to the actual amount of scrollback accumulated so far, so requesting more than exists simply lands at “top of history”.

pub fn scroll_down(&mut self, lines: usize)

Scroll down by lines (toward newer content / the live tail).

Saturates at 0 (live tail); calling with a huge value is equivalent to SerialPane::scroll_to_bottom.

pub fn scroll_to_top(&mut self)

Jump to the oldest row retained in the scrollback buffer.

Requests the configured scrollback capacity; vt100 internally clamps to however much history actually exists.

pub fn scroll_to_bottom(&mut self)

Jump back to the live tail (scrollback_offset == 0).