Struct LocalPty 

pub struct LocalPty { /* private fields */ }

A program on this machine, on a PTY (ConPTY on Windows), through portable-pty as rs-rich-record’s tapes run theirs.

Implementations

impl LocalPty

pub fn new(command: impl Into<Command>) -> LocalPty

pub fn backpressure(self, bytes: usize) -> LocalPty

Hold at most about bytes of output that has not been read (one read of the PTY more, at most 64 KiB); past it, stop reading the program’s output until some is read, so its writes wait, as they do on a slow terminal. Nothing is dropped, at any limit (16 MiB’s or more included): memory is bounded by the limit itself. Without this, output is never waited for: past 16 MiB unread, the oldest is dropped. For a reader that may fall behind and must not lose anything, such as a browser at the end of a network (rs-rich-web).

Trait Implementations

impl Drop for LocalPty

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.

impl PtyHost for LocalPty

fn write(&mut self, bytes: &[u8]) -> Result<()>

Refused with io::ErrorKind::WouldBlock while 1 MiB of input the program has not read is held (one write more at most), so a flood of pastes to a program that is not reading costs a bounded amount of memory. A pane drops what is refused.

fn kill(&mut self) -> Result<()>

Hang up on the program (SIGHUP on Unix, as a terminal closing does; on Windows it ends at once). One still running a second later, such as one that ignores SIGHUP, is killed with SIGKILL, with everything in its process group.

fn start(&mut self, columns: u16, rows: u16) -> Result<()>

Start the program on a screen columns x rows cells. Called once, when the pane is first laid out.

fn resize(&mut self, columns: u16, rows: u16) -> Result<()>

The pane is now columns x rows cells.

fn read(&mut self) -> Vec<u8>

The output that arrived since the last call; empty when there is none. Never blocks.

fn set_notify(&mut self, notify: Notify)

Call notify whenever output arrives or the program exits. Given once, before or after start; a host with something already waiting calls it at once.

fn exit_status(&mut self) -> Option<ExitStatus>

How the program ended, once it has, and once the output it wrote before that has been read.