Struct TerminalHandle 

pub struct TerminalHandle { /* private fields */ }

Available on crate feature terminal only.

Handle to a running terminal instance.

Multiple Terminal components can share the same handle. The PTY is closed when the last handle is dropped.

Implementations

impl TerminalHandle

pub fn new( id: TerminalId, command: CommandBuilder, scrollback_length: Option<usize>, ) -> Result<TerminalHandle, TerminalError>

Spawn a PTY for command and return a handle. Defaults to 1000 lines of scrollback when scrollback_length is None.

Example

use freya_terminal::prelude::*;
use portable_pty::CommandBuilder;

let mut cmd = CommandBuilder::new("bash");
cmd.env("TERM", "xterm-256color");

let handle = TerminalHandle::new(TerminalId::new(), cmd, None).unwrap();

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

Write data to the PTY, dropping any selection and snapping the viewport back to the bottom so the user sees fresh output.

pub fn last_write_elapsed(&self) -> Duration

Time since the user last wrote input to the PTY.

pub fn write_key( &self, key: &Key, modifiers: Modifiers, ) -> Result<bool, TerminalError>

Translate a key event into the matching terminal escape sequence and write it to the PTY. Returns whether the key was recognised.

pub fn paste(&self, text: &str) -> Result<(), TerminalError>

Paste text into the PTY, wrapping in bracketed-paste markers if the running app has enabled them.

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

Resize the terminal. alacritty’s grid reflows on width changes and preserves scrollback on height changes, so this is lossless.

pub fn scroll(&self, delta: i32)

Scroll the terminal by the specified delta. Positive delta moves the viewport up into scrollback history, matching the vt100 convention.

pub fn scroll_to_bottom(&self)

Scroll the terminal to the bottom of the buffer.

pub fn cwd(&self) -> Option<PathBuf>

Get the current working directory reported by the shell via OSC 7.

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

Get the window title reported by the shell via OSC 0 or OSC 2.

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

Get the latest clipboard content set by the terminal app via OSC 52.

pub fn mouse_move(&self, row: usize, col: usize)

Handle a mouse move/drag event based on the active mouse mode.

pub fn mouse_down(&self, row: usize, col: usize, button: TerminalMouseButton)

Handle a mouse button press event.

pub fn mouse_up(&self, row: usize, col: usize, button: TerminalMouseButton)

Handle a mouse button release event.

pub fn release(&self)

Handle a mouse button release from outside the terminal viewport.

pub fn wheel(&self, delta_y: f64, row: usize, col: usize)

Route a wheel event to scrollback, PTY mouse events, or arrow-key sequences depending on whether an app is tracking the mouse and whether we’re on the alternate screen (matches wezterm/kitty).

pub fn term(&self) -> Ref<'_, Term<EventProxy>>

Borrow the underlying alacritty Term for direct read access. Used by the renderer and accessibility code to inspect the grid without holding a separate snapshot.

pub fn output_received(&self) -> impl Future<Output = ()>

Future that completes each time new output is received from the PTY.

pub fn title_changed(&self) -> impl Future<Output = ()>

Future that completes when the window title changes (OSC 0 / OSC 2).

pub fn clipboard_changed(&self) -> impl Future<Output = ()>

Future that completes when clipboard content changes (OSC 52).

pub fn closed(&self) -> impl Future<Output = ()>

Future that completes when the PTY closes.

pub fn id(&self) -> TerminalId

Returns the unique identifier for this terminal instance.

pub fn shift_pressed(&self, pressed: bool)

Track whether shift is currently pressed.

pub fn start_selection(&self, row: usize, col: usize)

pub fn update_selection(&self, row: usize, col: usize)

Extend the in-progress selection, if any.

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

Returns the currently selected text as a string, if any.

Trait Implementations

impl Clone for TerminalHandle

fn clone(&self) -> TerminalHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for TerminalHandle

fn eq(&self, other: &TerminalHandle) -> 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.