Skip to main content

TerminalPane

Struct TerminalPane 

Source
pub struct TerminalPane {
    pub id: String,
    pub host: String,
    pub user: String,
    pub cwd: String,
    pub status: TerminalStatus,
    pub lines: Vec<TerminalLine>,
}
Expand description

A single pane rendered by MultiTerminal.

Fields§

§id: String

Stable identifier used as the key in the broadcast set and event target list. Must be unique across panes in a single MultiTerminal.

§host: String

Hostname shown in the header and prompt.

§user: String

Username shown in the prompt. Default: "user".

§cwd: String

Working directory shown in the prompt. Default: "~".

§status: TerminalStatus

Connection status. Default: TerminalStatus::Connected.

§lines: Vec<TerminalLine>

Scrollback buffer. Oldest line at index 0, newest at the end.

Implementations§

Source§

impl TerminalPane

Source

pub fn new(id: impl Into<String>, host: impl Into<String>) -> Self

Create a pane with the given id and hostname. Defaults: user "user", cwd "~", status TerminalStatus::Connected, no lines.

Source

pub fn user(self, user: impl Into<String>) -> Self

Set the username shown in the prompt.

Source

pub fn cwd(self, cwd: impl Into<String>) -> Self

Set the working directory shown in the prompt.

Source

pub fn status(self, status: TerminalStatus) -> Self

Set the connection status.

Source

pub fn push(self, line: TerminalLine) -> Self

Append a line to the scrollback buffer (builder form).

Source

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

Append a line at runtime.

Source

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

Replace the connection status at runtime.

Source

pub fn command_line(&self, cmd: impl Into<String>) -> TerminalLine

Build a command echo line targeting this pane. Convenience helper: the prompt pieces are filled from the pane’s own user/host/cwd.

Trait Implementations§

Source§

impl Clone for TerminalPane

Source§

fn clone(&self) -> TerminalPane

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalPane

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,