Struct ActiveTerminal 

#[non_exhaustive]
pub struct ActiveTerminal {
    pub task_handle: JoinHandle<()>,
    pub surface_output_rx: Receiver<Output>,
    pub pty_input_tx: Sender<BytesFromSTDIN>,
    pub control_tx: Sender<Protocol>,
}

An active terminal is running in a Tokio task, so we don’t have direct access to the underlying wezterm_term::Terminal. Instead we interact with it and the PTY through Tokio channels.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_handle: JoinHandle<()>

The task handle to the actively running [crate::shadow_tty::ShadowTerminal]

surface_output_rx: Receiver<Output>

A Tokio channel that receives termwiz::surface::Surface updates of the underlying terminal.

pty_input_tx: Sender<BytesFromSTDIN>

A Tokio channel that forwards bytes to the underlying PTY’s STDIN.

control_tx: Sender<Protocol>

A Tokio broadcast sender to send protocol messages that control the shadow terminal and PTY. For example; resizing and shutting down.

Implementations

impl ActiveTerminal

pub fn start(config: Config) -> Self

Start a [crate::shadow_tty::ShadowTerminal] running in a Tokio task.

pub async fn send_input( &self, bytes: BytesFromSTDIN, ) -> Result<(), SendError<BytesFromSTDIN>>

Send input directly into the underlying PTY process. This doesn’t go through the shadow terminal’s “frontend”.

Errors

If sending the bytes fails

pub fn kill(&self) -> Result<usize, SendError<Protocol>>

End all loops and send OS kill signals to the underlying PTY.

Errors

If sending message over channel fails.

pub fn resize( &self, width: u16, height: u16, ) -> Result<usize, SendError<Protocol>>

Resize the shadow terminal “frontend”. The PTY is agnostic about size.

Errors

If sending message over channel fails.

pub fn scroll_up(&self) -> Result<usize, SendError<Protocol>>

Scroll the shadow Wezterm terminal up.

Errors

If sending message over channel fails.

pub fn scroll_down(&self) -> Result<usize, SendError<Protocol>>

Scroll the shadow Wezterm terminal down.

Errors

If sending message over channel fails.

pub fn scroll_cancel(&self) -> Result<usize, SendError<Protocol>>

Cancel scrolling, and return the scroll to normal.

Errors

If sending message over channel fails.

Trait Implementations

impl Drop for ActiveTerminal

fn drop(&mut self)

Executes the destructor for this type.