Skip to main content

Terminal

Trait Terminal 

Source
pub trait Terminal: Send + Sync {
    // Required methods
    fn size(&self) -> Size;
    fn next_key(&mut self) -> Option<KeyEvent>;
    fn push_keys(&mut self, keys: &[KeyEvent]);
    fn write(&mut self, bytes: &[u8]);
    fn enter_alternate_screen(&mut self);
    fn leave_alternate_screen(&mut self);
    fn input_mode(&self) -> InputMode;
    fn set_input_mode(&mut self, mode: InputMode);
    fn flush(&mut self);
}
Expand description

The interactive terminal facade consumed by interactive programs.

Implementations are pure virtual-terminal state; a host adapter feeds KeyEvents in and renders the screen out.

Required Methods§

Source

fn size(&self) -> Size

The current screen size.

Source

fn next_key(&mut self) -> Option<KeyEvent>

Returns the next pending key event, if any.

Source

fn push_keys(&mut self, keys: &[KeyEvent])

Queues key events as if typed by the user.

Source

fn write(&mut self, bytes: &[u8])

Writes bytes, interpreting ANSI/VT control sequences.

Source

fn enter_alternate_screen(&mut self)

Enters the alternate screen buffer.

Source

fn leave_alternate_screen(&mut self)

Leaves the alternate screen buffer, restoring the main screen.

Source

fn input_mode(&self) -> InputMode

The current input mode.

Source

fn set_input_mode(&mut self, mode: InputMode)

Sets the input mode.

Source

fn flush(&mut self)

Flushes any buffered output.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§