Struct Terminal 

pub struct Terminal {
    inner: Arc<Inner>,
    thread: Mutex<Option<JoinHandle<()>>>,
}

One terminal.

Fields

inner: Arc<Inner>

thread: Mutex<Option<JoinHandle<()>>>

Implementations

impl Terminal

pub fn spawn(config: &TerminalConfig) -> Result<Self, Error>

Spawn a shell on a fresh PTY.

pub fn write_text(&self, text: &str) -> Result<(), Error>

Type text as-is.

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

Type raw bytes as-is: a client’s own keystrokes, which are already the bytes the PTY wants.

pub fn write_keys(&self, keys: &[Key]) -> Result<(), Error>

Press named keys, in order.

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

Resize the PTY and the model.

pub fn close(&self)

End the terminal: kill the process group and let the loop finish.

pub fn screen(&self) -> Screen

The visible screen as text.

pub fn read( &self, since: Option<u64>, max_lines: usize, max_bytes: usize, ) -> ReadResult

A bounded read of the scrollback and the screen.

pub fn repaint_and_seq(&self) -> (Vec<u8>, u32)

The visible screen as a VT stream, with the sequence the next chunk will carry - both read under the term’s lock, because the sequence is bumped under it after each parse. So every chunk below the sequence is already in the repaint, and no chunk at or above it is.

pub fn state(&self) -> State

What the terminal is doing.

pub fn subscribe(&self) -> Receiver<OutputChunk>

The output stream, from the next chunk.

pub fn state_stream(&self) -> Receiver<State>

The state stream, from the current value.

pub fn exit_stream(&self) -> Receiver<bool>

A stream that fires once, when the shell exits.

pub fn is_alive(&self) -> bool

Whether the shell process is alive.

pub fn shell_exit(&self) -> Option<Exit>

The shell’s own exit, once it has one.

pub fn cols(&self) -> u16

pub fn rows(&self) -> u16

pub fn shell(&self) -> &str

pub fn cwd(&self) -> &Path

pub fn title(&self) -> String

The title the shell last set, when it set one.

Trait Implementations

impl Drop for Terminal

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.