Struct TerminalManager 

pub struct TerminalManager { /* private fields */ }

Terminal manager that wraps the PTY session

Implementations

impl TerminalManager

pub fn get_clipboard_history(&self, slot: ClipboardSlot) -> Vec<ClipboardEntry>

Get clipboard history for a specific slot

pub fn get_latest_clipboard( &self, slot: ClipboardSlot, ) -> Option<ClipboardEntry>

Get the most recent clipboard entry for a slot

pub fn search_clipboard_history( &self, query: &str, slot: Option<ClipboardSlot>, ) -> Vec<ClipboardEntry>

Search clipboard history across all slots or a specific slot

pub fn add_to_clipboard_history( &self, slot: ClipboardSlot, content: String, label: Option<String>, )

Add content to clipboard history

pub fn clear_clipboard_history(&self, slot: ClipboardSlot)

Clear clipboard history for a specific slot

pub fn clear_all_clipboard_history(&self)

Clear all clipboard history

pub fn set_max_clipboard_sync_events(&self, max: usize)

Set maximum clipboard sync events retained

pub fn set_max_clipboard_event_bytes(&self, max_bytes: usize)

Set maximum bytes cached per clipboard event

pub fn set_max_clipboard_sync_history(&self, max: usize)

Set maximum clipboard history entries per slot

impl TerminalManager

pub fn get_graphics(&self) -> Vec<TerminalGraphic>

Get all graphics (Sixel, iTerm2, Kitty) Returns a vector of cloned TerminalGraphic objects for rendering

pub fn get_graphics_at_row(&self, row: usize) -> Vec<TerminalGraphic>

Get graphics at a specific row

pub fn graphics_count(&self) -> usize

Get total graphics count

pub fn get_scrollback_graphics(&self) -> Vec<TerminalGraphic>

Get all scrollback graphics

pub fn update_animations(&self) -> bool

Update animations and return true if any frames changed

pub fn get_graphics_with_animations(&self) -> Vec<TerminalGraphic>

Get all graphics with current animation frames

impl TerminalManager

pub fn get_all_hyperlinks(&self) -> Vec<HyperlinkInfo>

Get all OSC 8 hyperlinks from the terminal

pub fn get_hyperlink_url(&self, hyperlink_id: u32) -> Option<String>

Get the URL for a specific hyperlink ID

impl TerminalManager

pub fn get_cells_with_scrollback( &self, scroll_offset: usize, selection: Option<((usize, usize), (usize, usize))>, rectangular: bool, _cursor: Option<((usize, usize), f32)>, ) -> Vec<Cell>

Get terminal grid with scrollback offset as Cell array for CellRenderer

impl TerminalManager

pub fn spawn_shell(&mut self) -> Result<(), Error>

Spawn a shell in the terminal

pub fn spawn_custom_shell(&mut self, command: &str) -> Result<(), Error>

Spawn a custom shell command in the terminal

pub fn spawn_custom_shell_with_args( &mut self, command: &str, args: &[String], ) -> Result<(), Error>

Spawn a custom shell with arguments

pub fn spawn_shell_with_dir( &mut self, working_dir: Option<&str>, env_vars: Option<&HashMap<String, String>>, ) -> Result<(), Error>

Spawn shell with optional working directory and environment variables

pub fn spawn_custom_shell_with_dir( &mut self, command: &str, args: Option<&[String]>, working_dir: Option<&str>, env_vars: Option<&HashMap<String, String>>, ) -> Result<(), Error>

Spawn custom shell with args, optional working directory, and environment variables

impl TerminalManager

pub fn new(cols: usize, rows: usize) -> Result<TerminalManager, Error>

Create a new terminal manager with the specified dimensions

pub fn new_with_scrollback( cols: usize, rows: usize, scrollback_size: usize, ) -> Result<TerminalManager, Error>

Create a new terminal manager with specified dimensions and scrollback size

pub fn set_theme(&mut self, theme: Theme)

Set the color theme

pub fn update_scrollback_metadata( &mut self, scrollback_len: usize, cursor_row: usize, )

Update scrollback metadata based on shell integration events from the core.

Drains the queued ShellIntegrationEvent events from the terminal, each of which carries the cursor_line at the exact moment the OSC 133 marker was parsed. This eliminates the batching problem where multiple markers arrive between frames and only the last one was visible via marker().

Command text is captured from the terminal grid when the marker changes away from CommandStart, then injected into scrollback marks after apply_event() creates them.

pub fn scrollback_marks(&self) -> Vec<ScrollbackMark>

Get rendered scrollback marks (prompt/command boundaries).

pub fn scrollback_previous_mark(&self, line: usize) -> Option<usize>

Find previous prompt mark before the given absolute line (if any).

pub fn scrollback_next_mark(&self, line: usize) -> Option<usize>

Find next prompt mark after the given absolute line (if any).

pub fn core_command_history(&self) -> Vec<(String, Option<i32>, Option<u64>)>

Get command history from the core library (commands tracked via shell integration).

Returns commands as (command_text, exit_code, duration_ms) tuples.

pub fn set_cell_dimensions(&self, width: u32, height: u32)

Set cell dimensions in pixels for sixel graphics scroll calculations

pub fn write(&self, data: &[u8]) -> Result<(), Error>

Write data to the PTY (send user input to shell)

pub fn write_str(&self, data: &str) -> Result<(), Error>

Write string to the PTY

pub fn process_data(&self, data: &[u8])

Process raw data through the terminal emulator (for tmux output routing).

pub fn paste(&self, content: &str) -> Result<(), Error>

Paste text to the terminal with proper bracketed paste handling.

pub async fn paste_with_delay( &self, content: &str, delay_ms: u64, ) -> Result<(), Error>

Paste text with a delay between lines.

pub fn content(&self) -> Result<String, Error>

Get the terminal content as a string

pub fn resize(&mut self, cols: usize, rows: usize) -> Result<(), Error>

Resize the terminal

pub fn resize_with_pixels( &mut self, cols: usize, rows: usize, width_px: usize, height_px: usize, ) -> Result<(), Error>

Resize the terminal with pixel dimensions

pub fn set_pixel_size( &mut self, width_px: usize, height_px: usize, ) -> Result<(), Error>

Set pixel dimensions for XTWINOPS CSI 14 t query support

pub fn dimensions(&self) -> (usize, usize)

Get the current terminal dimensions

pub fn terminal(&self) -> Arc<Mutex<RawMutex, Terminal>>

Get a clone of the underlying terminal for direct access

pub fn has_updates(&self) -> bool

Check if there have been updates since last check

pub fn is_running(&self) -> bool

Check if the PTY is still running

pub fn kill(&mut self) -> Result<(), Error>

Kill the PTY process

pub fn bell_count(&self) -> u64

Get the current bell event count

pub fn scrollback(&self) -> Vec<String>

Get scrollback lines

pub fn scrollback_len(&self) -> usize

Get scrollback length

pub fn line_text_at_absolute(&self, absolute_line: usize) -> Option<String>

Get text of a line at an absolute index (scrollback + screen).

pub fn lines_text_range(&self, start: usize, end: usize) -> Vec<(String, usize)>

Get all lines in a range as text (for search in copy mode).

pub fn scrollback_as_cells(&self) -> Vec<Vec<Cell>>

Get all scrollback lines as Cell arrays.

pub fn clear_scrollback(&self)

Clear scrollback buffer

pub fn clear_scrollback_metadata(&mut self)

Clear scrollback metadata (prompt marks, command history, timestamps).

pub fn search(&self, query: &str, case_sensitive: bool) -> Vec<SearchMatch>

Search for text in the visible screen.

pub fn search_scrollback( &self, query: &str, case_sensitive: bool, max_lines: Option<usize>, ) -> Vec<SearchMatch>

Search for text in the scrollback buffer.

pub fn search_all(&self, query: &str, case_sensitive: bool) -> Vec<SearchMatch>

Search for text in both visible screen and scrollback.

pub fn take_notifications(&self) -> Vec<Notification>

Take all pending OSC 9/777 notifications

pub fn has_notifications(&self) -> bool

Check if there are pending OSC 9/777 notifications

pub fn screenshot_to_file( &self, path: &Path, format: &str, scrollback_lines: usize, ) -> Result<(), Error>

Take a screenshot of the terminal and save to file

pub fn record_marker(&self, label: String)

Add a marker to the recording

pub fn export_recording_to_file( &self, session: &RecordingSession, path: &Path, format: &str, ) -> Result<(), Error>

Export recording to file (asciicast or JSON format)

pub fn shell_integration_cwd(&self) -> Option<String>

Get current working directory from shell integration (OSC 7)

pub fn shell_integration_exit_code(&self) -> Option<i32>

Get last command exit code from shell integration (OSC 133)

pub fn shell_integration_command(&self) -> Option<String>

Get current command from shell integration

pub fn shell_integration_hostname(&self) -> Option<String>

Get hostname from shell integration (OSC 7)

pub fn shell_integration_username(&self) -> Option<String>

Get username from shell integration (OSC 7)

pub fn poll_cwd_events(&self) -> Vec<CwdChange>

Poll CWD change events from terminal

pub fn poll_action_results(&self) -> Vec<ActionResult>

Poll trigger action results from the core terminal.

pub fn get_active_transfers(&self) -> Vec<FileTransfer>

pub fn get_completed_transfers(&self) -> Vec<FileTransfer>

pub fn take_completed_transfer(&self, id: u64) -> Option<FileTransfer>

pub fn cancel_file_transfer(&self, id: u64) -> bool

pub fn send_upload_data(&self, data: &[u8])

pub fn cancel_upload(&self)

pub fn poll_upload_requests(&self) -> Vec<String>

pub fn custom_session_variables(&self) -> HashMap<String, String>

pub fn shell_integration_stats(&self) -> ShellIntegrationStats

pub fn cursor_position(&self) -> (usize, usize)

Get cursor position

pub fn cursor_style(&self) -> CursorStyle

Get cursor style from terminal for rendering

pub fn set_cursor_style(&mut self, style: CursorStyle)

Set cursor style for the terminal

pub fn is_cursor_visible(&self) -> bool

Check if cursor is visible

pub fn is_mouse_tracking_enabled(&self) -> bool

Check if mouse tracking is enabled

pub fn report_focus_change(&self, focused: bool) -> bool

Send focus event to PTY if the application has enabled focus tracking (DECSET 1004). Returns true if the event was sent.

pub fn is_alt_screen_active(&self) -> bool

Check if alternate screen is active

pub fn modify_other_keys_mode(&self) -> u8

Get the modifyOtherKeys mode

pub fn application_cursor(&self) -> bool

Check if application cursor key mode (DECCKM) is enabled.

pub fn get_title(&self) -> String

Get the terminal title set by OSC 0, 1, or 2 sequences

pub fn shell_integration_marker(&self) -> Option<ShellIntegrationMarker>

Get the current shell integration marker state

pub fn is_command_running(&self) -> bool

Check if a command is currently running based on shell integration

pub fn get_running_command_name(&self) -> Option<String>

Get the name of the currently running command (first word only)

pub fn should_confirm_close(&self, jobs_to_ignore: &[String]) -> Option<String>

Check if tab close should show a confirmation dialog

pub fn should_report_mouse_motion(&self, button_pressed: bool) -> bool

Check if mouse motion events should be reported

pub fn encode_mouse_event( &self, button: u8, col: usize, row: usize, pressed: bool, modifiers: u8, ) -> Vec<u8>

Send a mouse event to the terminal and get the encoded bytes

pub fn get_styled_segments(&self) -> Vec<StyledSegment>

Get styled segments from the terminal for rendering

pub fn update_generation(&self) -> u64

Get the current generation number for dirty tracking

impl TerminalManager

pub fn progress_bar(&self) -> ProgressBar

Get the simple progress bar state (OSC 9;4)

pub fn named_progress_bars(&self) -> HashMap<String, NamedProgressBar>

Get all named progress bars (OSC 934)

pub fn has_any_progress(&self) -> bool

Check if any progress bar is currently active

impl TerminalManager

pub fn set_answerback_string(&self, answerback: Option<String>)

pub fn set_width_config(&self, config: WidthConfig)

pub fn set_normalization_form(&self, form: NormalizationForm)

pub fn set_output_callback<F>(&self, callback: F)

where F: Fn(&[u8]) + Send + Sync + 'static,

pub fn start_recording(&self, title: Option<String>)

pub fn stop_recording(&self) -> Option<RecordingSession>

pub fn is_recording(&self) -> bool

pub fn export_asciicast(&self, session: &RecordingSession) -> String

impl TerminalManager

pub fn start_coprocess(&self, config: CoprocessConfig) -> Result<u64, String>

pub fn stop_coprocess(&self, id: u64) -> Result<(), String>

pub fn coprocess_status(&self, id: u64) -> Option<bool>

pub fn read_from_coprocess(&self, id: u64) -> Result<Vec<String>, String>

pub fn list_coprocesses(&self) -> Vec<u64>

pub fn read_coprocess_errors(&self, id: u64) -> Result<Vec<String>, String>

impl TerminalManager

pub fn set_tmux_control_mode(&self, enabled: bool)

pub fn is_tmux_control_mode(&self) -> bool

pub fn drain_tmux_notifications(&self) -> Vec<TmuxNotification>

pub fn tmux_notifications(&self) -> Vec<TmuxNotification>

impl TerminalManager

pub fn sync_triggers(&self, triggers: &[TriggerConfig])

Sync trigger configs from Config into the core TriggerRegistry.

impl TerminalManager

pub fn add_observer(&self, observer: Arc<dyn TerminalObserver>) -> u64

pub fn remove_observer(&self, id: u64) -> bool

Trait Implementations

impl Drop for TerminalManager

fn drop(&mut self)

Executes the destructor for this type.