Struct PushBackend 

pub struct PushBackend { /* private fields */ }

A Backend a host pushes to: see the module docs.

It paints on the alternate screen unless told otherwise (inline), never reads (driving it with EventLoop::run fails with Unsupported), has a clipboard whose copies the host takes (PushPort::take_copies), and runs no command: a hand-off returns at once with no exit code.

Implementations

impl PushBackend

pub fn new(columns: u16, rows: u16) -> PushBackend

A columns x rows screen, at time zero.

pub fn inline(self) -> PushBackend

Paint inline, from the row the host’s cursor is on, instead of on the alternate screen.

pub fn port(&self) -> PushPort

The port the host keeps once the backend goes into an EventLoop.

Trait Implementations

impl Backend for PushBackend

fn size(&self) -> (u16, u16)

(columns, rows).

fn read(&mut self, _timeout: Option<Duration>) -> Result<Option<Event>>

The next event, or None when timeout passes first. None for timeout waits as long as it takes.

fn write(&mut self, text: &str) -> Result<()>

Write and flush.

fn elapsed(&self) -> Duration

Time since the backend started (virtual in the headless driver).

fn handoff(&mut self, _command: &mut Command) -> Result<Option<i32>>

Run command with the terminal as it was before the session, then take the terminal back. Returns the exit code.

fn alternate_screen(&self) -> bool

Whether the region is the alternate screen (painted from the top).

fn clipboard(&self) -> Result<(), String>

Whether copy reaches a clipboard (#488): Ok when it does, or why not. The default: it does not.

fn copy(&mut self, text: &str) -> Result<()>

Put text on the clipboard. Only called when clipboard is Ok.

fn synchronized_output(&self) -> bool

Whether write_frame writes each frame as one synchronized update. The default: no.

fn write_frame(&mut self, frame: &str) -> Result<()>

Write a frame the painter made: nothing at all when it is empty, and with synchronized_output between CSI ? 2026 h and CSI ? 2026 l, in the one write.

fn origin(&self) -> u16

The terminal row an inline region started on, for placing mouse events; 0 when unknown. The alternate screen always starts at 0.

fn painted(&mut self, text: &str)

The plain text of a view just painted: the headless driver records it.

fn can_suspend(&self) -> bool

Whether Ctrl+Z suspends (a real terminal on Unix), rather than reaching the component as a key.

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

Give the terminal back, stop until the shell continues the process, then take the terminal back. Only called when can_suspend.

fn take_resumed(&mut self) -> bool

Whether the process was suspended from outside (SIGTSTP) and has continued since the last call: the screen is then the shell’s.

fn waker(&mut self) -> Option<Waker>

A Waker that ends a read under way early, for another thread to call when it has something for the loop; the same one each time. The default: none, so what another thread sends waits for the read’s timeout.

fn releases_reported(&self) -> Releases

Which key releases the backend reports (see Releases). The default: none.