Struct Session 

pub struct Session { /* private fields */ }

A shell running in the panel.

Implementations

impl Session

pub fn spawn( id: u64, label: &str, argv: &[String], cwd: &Path, (rows, cols): (u16, u16), notify: Sender<WorkerMsg>, ) -> Result<Self, String>

Starts argv in cwd inside a pseudo-terminal of rows × cols.

Output and exit are reported on notify as WorkerMsg::TerminalOutput and WorkerMsg::TerminalExited, tagged with id.

Errors

Returns a description of what failed — the pseudo-terminal could not be created, or the program could not be started (most often: not found).

pub fn id(&self) -> u64

The identifier output and exit messages carry.

pub fn label(&self) -> &str

The profile name the session was started from.

pub fn pid(&self) -> Option<u32>

The shell’s process id, when the platform reported one.

pub fn write(&self, bytes: Vec<u8>)

Queues bytes for the shell. Never blocks.

pub fn screen(&self) -> MutexGuard<'_, Parser<Replies>>

Locks the screen for reading or for a scroll change.

Held only for as long as one frame takes to copy cells out, so the reader thread is never kept waiting for longer than that.

pub fn output_drawn(&self)

Lets the reader announce new output again, once the last batch is on screen.

pub fn resize(&mut self, (rows, cols): (u16, u16))

Resizes the pseudo-terminal and the screen to rows × cols, if they changed. Cheap enough to call every frame.

pub fn scroll(&self, delta: isize)

Scrolls the view delta rows into the scrollback (positive is back in time), clamped to what the scrollback holds.

pub fn scroll_to_bottom(&self)

Returns the view to the live screen.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Drop for Session

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.