Struct Screen 

pub struct Screen { /* private fields */ }

One pane screen, including scrollback, alternate-screen state, cursor position, modes, tab stops, and hyperlink storage.

Implementations

impl Screen

pub fn capture_transcript( &self, range: ScreenCaptureRange, options: GridRenderOptions, ) -> Vec<u8>

Captures a tmux-style line range over the current grid contents.

pub fn capture_transcript_lines_independent( &self, range: ScreenCaptureRange, options: GridRenderOptions, ) -> Vec<Vec<u8>>

Captures physical lines with each line rendered from a fresh ANSI state.

This is intended for renderers that repaint individual terminal rows: a row must carry its own SGR state instead of depending on a previous captured row having been emitted first.

pub fn capture_saved_transcript( &self, range: ScreenCaptureRange, options: GridRenderOptions, ) -> Option<Vec<u8>>

Captures the saved pre-alternate-screen copy when alternate mode is active.

impl Screen

pub fn tmux_history_bytes(&self) -> usize

Returns tmux-compatible grid allocation bytes for #{history_bytes}.

pub fn tmux_history_all_bytes(&self) -> String

Returns tmux-compatible grid allocation counters for #{history_all_bytes}.

impl Screen

pub fn mark_selected_row_range(&mut self, row: u32, start_x: u32, end_x: u32)

Marks one visible row range as selected.

pub fn overlay_style_on_selected(&mut self, style_input: &str)

Overlays style_input onto all selected visible cells.

impl Screen

pub fn overlay_style_on_default_cells(&mut self, style_input: &str)

Applies style_input only where the application left cell styling unset.

pub fn overlay_default_style(&mut self, style: &Style)

Applies style only where the application left cell styling unset.

impl Screen

pub fn absolute_line_view(&self, absolute_y: usize) -> Option<ScreenLineView>

Returns a read-only copy of one absolute line.

pub fn clone_viewport( &self, top_line: usize, cursor_x: u32, cursor_absolute_y: usize, ) -> Self

Clones the screen as a standalone viewport over its absolute lines.

impl Screen

pub fn new(size: TerminalSize, history_limit: usize) -> Self

Creates a new screen with the given geometry and history limit.

pub const fn mode(&self) -> u32

Returns the current terminal mode flags.

pub const fn cursor_style(&self) -> u32

Returns the most recent DECSCUSR cursor style parameter.

pub fn size(&self) -> TerminalSize

Returns the screen size.

pub fn title(&self) -> &str

Returns the current screen title.

pub fn set_title(&mut self, title: impl Into<String>)

Sets the current screen title.

pub fn path(&self) -> &str

Returns the most recent OSC 7 path.

pub fn is_alternate(&self) -> bool

Returns whether the alternate screen is active.

pub fn history_limit(&self) -> usize

Returns the configured history limit.

pub fn history_size(&self) -> usize

Returns the current history size in rows.

pub const fn cursor_position(&self) -> (u32, u32)

Returns the current cursor position within the visible viewport.

pub fn cursor_absolute_y(&self) -> usize

Returns the absolute cursor row including history.

pub fn absolute_line_count(&self) -> usize

Returns the total number of absolute lines retained by the screen.

pub fn delete_visible_line(&mut self, y: u32) -> bool

Deletes one visible line and scrolls the remaining viewport content up.

This clears any pending wrap state because deleting a visible row invalidates the previous cursor edge condition.

pub fn delete_absolute_line(&mut self, absolute_y: usize) -> bool

Deletes one absolute line from history or the visible viewport.

pub fn history_bytes(&self) -> usize

Returns the current retained history size in bytes.

pub fn take_bell_count(&mut self) -> u64

Drains and returns the number of BEL notifications observed since the last drain.

pub fn take_terminal_passthrough(&mut self) -> Vec<TerminalPassthrough>

Drains terminal passthrough events observed since the last drain.

pub fn take_terminal_passthrough_dropped_count(&mut self) -> u64

Drains the count of terminal passthrough events dropped by safety limits.

pub fn hyperlink_uri(&self, inner_id: u32) -> Option<&str>

Returns the stored OSC 8 URI for a hyperlink inner ID.

pub fn set_history_limit(&mut self, limit: usize)

Updates the history limit.

pub fn set_utf8_config(&mut self, utf8_config: Utf8Config)

Updates the tmux-style UTF-8 width and combining configuration.

pub fn resize(&mut self, size: TerminalSize)

Resizes the screen and resets the scroll region.

pub fn clear_history_and_hyperlinks(&mut self, reset_hyperlinks: bool)

Clears history and optionally resets stored hyperlinks.

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Screen

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Screen

fn eq(&self, other: &Screen) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ScreenWriter for Screen

fn collect_add(&mut self, ch: char, cell: &CellState)

Add a printable character with current cell attributes.

fn collect_add_with_charset(&mut self, ch: char, cell: &CellState, acs: bool)

Add a printable character, applying ACS charset if acs is true.

fn cursor_up(&mut self, n: u32)

Move cursor up by n rows.

fn cursor_down(&mut self, n: u32)

Move cursor down by n rows.

fn cursor_left(&mut self, n: u32)

Move cursor left by n columns.

fn cursor_right(&mut self, n: u32)

Move cursor right by n columns.

fn cursor_move(&mut self, col: i32, row: i32, origin_mode: bool)

Move cursor to absolute position. -1 means “don’t change”.

fn insert_line(&mut self, n: u32, bg: i32)

Insert n blank lines at cursor, scrolling down.

fn delete_line(&mut self, n: u32, bg: i32)

Delete n lines at cursor, scrolling up.

fn scroll_up(&mut self, n: u32, bg: i32)

Scroll up by n lines.

fn scroll_down(&mut self, n: u32, bg: i32)

Scroll down by n lines.

fn linefeed(&mut self, wrapped: bool, bg: i32)

Line feed.

fn reverse_index(&mut self, bg: i32)

Reverse index (scroll down or move up).

fn carriage_return(&mut self)

Carriage return.

fn backspace(&mut self)

Backspace.

fn insert_character(&mut self, n: u32, bg: i32)

Insert n blank characters at cursor.

fn delete_character(&mut self, n: u32, bg: i32)

Delete n characters at cursor.

fn clear_character(&mut self, n: u32, bg: i32)

Erase (clear) n characters at cursor.

fn clear_end_of_screen(&mut self, bg: i32)

Clear to end of screen.

fn clear_start_of_screen(&mut self, bg: i32)

Clear from start of screen.

fn clear_screen(&mut self, bg: i32)

Clear entire screen.

fn clear_history(&mut self)

Clear scrollback history.

fn clear_end_of_line(&mut self, bg: i32)

Clear to end of line.

fn clear_start_of_line(&mut self, bg: i32)

Clear from start of line.

fn clear_line(&mut self, bg: i32)

Clear entire line.

fn mode_set(&mut self, mode_bits: u32)

Set mode bits.

fn mode_clear(&mut self, mode_bits: u32)

Clear mode bits.

fn set_scroll_region(&mut self, top: u32, bottom: u32)

Set scroll region (top and bottom margins, 0-based).

fn alternate_on(&mut self, bg: i32, save_cursor: bool)

Switch to alternate screen. save_cursor = true for 1049.

fn alternate_off(&mut self, _bg: i32, restore_cursor: bool)

Switch back from alternate screen.

fn tab(&mut self)

Handle a horizontal tab.

fn cursor_backward_tab(&mut self, n: u32)

Move cursor backward n tab stops (CBT).

fn set_tab_stop(&mut self)

Set a tab stop at the current cursor column.

fn clear_tab_stop(&mut self)

Clear a tab stop at the current cursor column.

fn clear_all_tab_stops(&mut self)

Clear all tab stops.

fn set_title(&mut self, title: &str)

Set the pane/window title.

fn set_window_name(&mut self, name: &str)

Set the window name (from rename string).

fn set_path(&mut self, path: &str)

Set the current directory path (OSC 7).

fn save_cursor(&mut self)

Save cursor state (DECSC).

fn restore_cursor(&mut self)

Restore cursor state (DECRC).

fn alignment_test(&mut self)

Fill screen with ‘E’ characters (DECALN).

fn full_reset(&mut self)

Full terminal reset (RIS).

fn start_sync(&mut self)

Start synchronized output.

fn stop_sync(&mut self)

Stop synchronized output and redraw.

fn set_cursor_style(&mut self, n: u32)

Set cursor style (DECSCUSR). n is the Ps value 0-6.

fn osc_hyperlink(&mut self, data: &str)

Handle OSC 8 hyperlink.

fn current_hyperlink_id(&self) -> u32

Returns the active OSC 8 hyperlink inner ID.

fn bell(&mut self)

Ring the bell (BEL).

fn apc_passthrough(&mut self, data: &[u8])

Handle an opaque APC passthrough string.

fn sixel_passthrough(&mut self, data: &[u8])

Handle an opaque SIXEL DCS passthrough string.

fn screen_size_x(&self) -> u32

Get screen width in columns.

fn screen_size_y(&self) -> u32

Get screen height in rows.

fn cursor_x(&self) -> u32

Get current cursor column (0-based).

fn cursor_y(&self) -> u32

Get current cursor row (0-based).

fn current_mode(&self) -> u32

Get current screen mode flags.

fn push_title(&mut self)

Push current title onto the stack.

fn pop_title(&mut self)

Pop title from the stack.

fn osc_palette(&mut self, _data: &str, _end: InputEndType)

Handle OSC 4 palette colour.

fn osc_notification(&mut self, _data: &str)

Handle OSC 9 notification.

fn osc_fg_colour(&mut self, _data: &str, _end: InputEndType)

Handle OSC 10 fg colour query/set.

fn osc_bg_colour(&mut self, _data: &str, _end: InputEndType)

Handle OSC 11 bg colour query/set.

fn osc_cursor_colour(&mut self, _data: &str, _end: InputEndType)

Handle OSC 12 cursor colour query/set.

fn osc_clipboard(&mut self, _data: &str, _end: InputEndType)

Handle OSC 52 clipboard.

fn osc_reset_palette(&mut self, _data: &str)

Handle OSC 104 reset palette.

fn osc_reset_fg(&mut self)

Handle OSC 110 reset fg.

fn osc_reset_bg(&mut self)

Handle OSC 111 reset bg.

fn osc_reset_cursor(&mut self)

Handle OSC 112 reset cursor colour.

fn osc_shell_integration(&mut self, _data: &str)

Handle OSC 133 shell integration.

fn collect_end(&mut self)

End character collection (flush). Called before non-print transitions.

fn reset_attributes(&mut self)

Reset cell attributes to default.

fn dcs_passthrough(&mut self, data: &[u8])

Handle DCS passthrough string.

fn notify_pane_title_changed(&mut self)

Signal that the pane title changed.

impl Eq for Screen

impl StructuralPartialEq for Screen