Struct TerminalHandle 

pub struct TerminalHandle { /* private fields */ }

Available on crate feature terminal only.

Handle to a running terminal instance.

The handle allows you to write input to the terminal and resize it. Multiple Terminal components can share the same handle.

The PTY is automatically closed when the handle is dropped.

Implementations

impl TerminalHandle

pub fn new(command: CommandBuilder) -> Result<TerminalHandle, TerminalError>

Create a new terminal with the specified command.

Example

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

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

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

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

Write data to the terminal.

Example

handle.write(b"ls -la\n").unwrap();

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

Resize the terminal to the specified rows and columns.

Example

handle.resize(24, 80);

pub fn read_buffer(&self) -> TerminalBuffer

Read the current terminal buffer.

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

Returns a future that completes when the terminal/PTY closes.

This can be used to detect when the shell process exits and update the UI accordingly.

Example

use_future(move || async move {
    terminal_handle.closed().await;
    // Terminal has exited, update UI state
});

pub fn id(&self) -> TerminalId

Returns the unique identifier for this terminal instance.

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.