Struct MultiTerminal 

pub struct MultiTerminal { /* private fields */ }

Multi-pane terminal with per-pane broadcast toggles.

See the module-level documentation for the full interaction model.

Implementations

impl MultiTerminal

pub fn new(id_salt: impl Hash) -> Self

Create an empty widget. id_salt scopes the widget’s memory state; two MultiTerminals on the same page need distinct salts.

pub fn with_pane(self, pane: TerminalPane) -> Self

Add a pane at construction time (builder form).

pub fn columns(self, columns: usize) -> Self

Render with a fixed number of columns in the pane grid. Panes wrap after columns per row. Default: 2.

See also columns_auto for a width-responsive mode that’s better suited to large pane counts.

pub fn columns_auto(self, min_col_width: f32) -> Self

Render with a width-responsive column count. Each frame the grid picks the largest column count such that every column is at least min_col_width points wide, clamped between 1 and the number of panes. With 16 panes, this naturally produces 3–4 columns on a wide monitor and 1–2 on a narrow sidebar.

min_col_width is clamped to a minimum of 240 pt so the pane header always has room for the chevron, hostname, solo button, broadcast pill and status indicator.

pub fn pane_min_height(self, h: f32) -> Self

Minimum height of a single pane, in points. Default: 220.0.

pub fn scrollback_cap(self, n: usize) -> Self

Cap on the number of lines retained per pane. Older lines are dropped when the buffer exceeds this count. Default: 500.

pub fn add_pane(&mut self, pane: TerminalPane)

Append a pane at runtime.

pub fn remove_pane(&mut self, id: &str)

Remove a pane by id.

pub fn pane(&self, id: &str) -> Option<&TerminalPane>

Borrow a pane by id.

pub fn pane_mut(&mut self, id: &str) -> Option<&mut TerminalPane>

Borrow a pane mutably by id.

pub fn panes(&self) -> &[TerminalPane]

All panes, in grid order.

pub fn push_line(&mut self, id: &str, line: TerminalLine)

Append a line to the pane with the given id. No-op if not found. Applies the scrollback cap.

pub fn set_status(&mut self, id: &str, status: TerminalStatus)

Change a pane’s status at runtime. If the pane leaves the connected state, it’s removed from the broadcast set.

pub fn focused(&self) -> Option<&str>

Id of the currently focused pane, if any.

pub fn set_focused(&mut self, id: Option<String>)

Programmatically set the focused pane.

pub fn broadcast(&self) -> &HashSet<String>

Current broadcast set (pane ids that will receive input). Does not include offline panes.

pub fn set_broadcast(&mut self, set: HashSet<String>)

Replace the broadcast set wholesale. Invalidates the stash used by the Solo / All-on toggles.

pub fn is_collapsed(&self, id: &str) -> bool

Whether a pane is currently collapsed (rendered as a header-only strip with its scrollback hidden).

pub fn set_collapsed(&mut self, id: &str, collapsed: bool)

Collapse or expand a pane by id.

pub fn toggle_collapsed(&mut self, id: &str)

Flip the collapsed state of a pane.

pub fn collapse_all(&mut self)

Collapse every pane to its header strip.

pub fn expand_all(&mut self)

Expand every pane back to full height.

pub fn toggle_broadcast(&mut self, id: &str)

Toggle whether id is in the broadcast set. Connected panes only.

pub fn solo(&mut self, id: &str)

Collapse the broadcast set to just the pane with the given id, and focus that pane. Calling solo on a pane that’s already the sole receiver restores the previously-stashed set (so the button toggles).

No-op if the id doesn’t match a connected pane.

pub fn solo_focused(&mut self)

Solo the currently-focused pane. See solo for the toggle semantics. Bound to the Cmd/Ctrl+D shortcut.

pub fn broadcast_all(&mut self)

Toggle broadcast on every connected pane. If every connected pane is already in the broadcast set, clears it; otherwise fills it with every connected pane.

Note: when the set ends up empty, the focused pane still receives input as a fallback so the buffer always has somewhere to go.

pub fn invert_broadcast(&mut self)

Flip the broadcast state on every connected pane (off becomes on and vice versa). Clears the stash.

pub fn pending(&self) -> &str

Current pending input (what the user is typing).

pub fn clear_pending(&mut self)

Clear the pending input buffer.

pub fn take_events(&mut self) -> Vec<TerminalEvent>

Drain and return the events accumulated since the previous call. Call this once per frame after show to react to user-submitted commands.

pub fn show(&mut self, ui: &mut Ui) -> Response

Render the widget. Call once per frame inside a CentralPanel or similar container.

Trait Implementations

impl Debug for MultiTerminal

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

Formats the value using the given formatter.