Struct TerminalPanel 

pub struct TerminalPanel { /* private fields */ }

The panel’s state: its shells, and how it is shown.

Implementations

impl TerminalPanel

pub fn attach(&mut self, notify: Sender<WorkerMsg>)

Connects the panel to the worker channel its sessions report on. Until this is called — as in tests — opening a shell is an error.

pub fn is_visible(&self) -> bool

Whether the panel is on screen.

pub fn shell_focused(&self) -> bool

Whether keystrokes go to the shell rather than to Trail.

pub fn is_maximized(&self) -> bool

Whether the panel takes the whole screen above the status bar.

pub fn sessions(&self) -> &[Session]

The open shells, in tab order.

pub fn active(&self) -> usize

Index of the shell on screen.

pub fn pending(&self) -> Option<&Confirm>

The question waiting for an answer, if any.

pub fn resize_all(&mut self, size: (u16, u16))

Resizes every shell to the panel’s inner size. Called by the renderer, which is where the size is known.

pub fn note_output(&mut self)

Records that a shell produced output. The event loop draws it at the next frame rather than immediately, so a flood is drawn at a capped rate.

A hidden panel draws nothing, so its output is not worth a frame. Its readers stay quiet until the next frame drawn for any other reason resets them, which also means a hidden shell costs one message per frame at most, however much it prints.

pub fn output_pending(&self) -> bool

Whether output is waiting to be drawn.

pub fn frame_drawn(&mut self)

Called after a frame is drawn: what was pending is on screen, and every reader may announce new output again.

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

Removes the shell id after it exited. Returns whether anything changed.

pub fn new_shell( &mut self, config: &TerminalConfig, profile_name: Option<&str>, cwd: &Path, ) -> Result<(), String>

Starts a new shell from profile_name (or the default) in cwd, makes it the active one, and shows and focuses the panel.

Errors

Returns a message for the status bar when the profile is unknown, the panel is not attached, or the program cannot be started.

pub fn toggle( &mut self, config: &TerminalConfig, cwd: &Path, ) -> Result<(), String>

The toggle key: shows the panel (starting a shell if there is none) and focuses it, or hides it and returns focus to the file list.

Errors

As Self::new_shell, when opening has to start a shell.

pub fn switch_focus( &mut self, config: &TerminalConfig, cwd: &Path, ) -> Result<(), String>

The focus key: moves the keyboard to the other side, opening the panel first if it is hidden.

Errors

As Self::new_shell, when opening has to start a shell.

pub fn cycle(&mut self, delta: isize)

Switches to the shell delta tabs away, wrapping.

pub fn select(&mut self, n: usize) -> Result<(), String>

Switches to shell number n, counted from 1 as the tabs are labelled.

Errors

Returns a message when there is no shell n.

pub fn close_active(&mut self)

Ends the active shell now, without asking.

pub fn toggle_maximized(&mut self)

Maximizes the panel, or restores it.

pub fn quit_confirmation( &self, policy: ConfirmPolicy, cancel: bool, ) -> Option<Confirm>

Whether quitting needs a confirmation under policy, and if so the question to ask. Reads the process table when the policy is when_busy, which costs tens of milliseconds — fine on a quit.

pub fn request_close(&mut self, policy: ConfirmPolicy)

:term close: closes the active shell, or asks first under policy.

pub fn ask(&mut self, confirm: Confirm)

Puts a quit question up for the user to answer.

Trait Implementations

impl Debug for TerminalPanel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TerminalPanel

fn default() -> Self

Returns the “default value” for a type.